@plusauth/oidc-client-js

@plusauth/oidc-client-js

OpenID Connect (OIDC) and OAuth2 library for browser based JavaScript applications.

Features

• Silent Authentication
• Automatic Access Token Renewal
• OAuth 2.0 Token Revocation
• Session Management (with logout functionality)
• PKCE
• JWT payload validation
• Can be used with any OAuth 2.0 / OpenID Connect provider
• Cross tab/window login synchronization
• Dispatches single request per tab/window to prevent inconsistency
• Official TypeScript support

Table of Contents

• Installation
• Documentation
• Api Docs
• Examples

Installation

From the CDN:

⚠ NOTE: Although @plusauth/oidc-client-js follows semantic versioning, we advise using specific versions in CDN links as they are easy to forget and latest version may break up your application. Make sure to check releases and use the specific version.

<script src="https://unpkg.com/@plusauth/oidc-client-js@1.3.0/dist/oidc-client.min.js"></script>

Using npm:

npm install @plusauth/oidc-client-js

or yarn:

yarn add @plusauth/oidc-client-js

Documentation

Documentation is served on PlusAuth documentation site. You can reach it from here

Api Docs

Please visit here

Browser Support

Browserlist Coverage

This library uses global fetch api. If your app requires to be working in environment that does not have fetch you must use a polyfill like whatwg-fetch.

Examples

Have a look at examples directory for various examples

Changelog

1.4.1 (2023-10-17)

Bug Fixes

• access token renewal wont start on inital load (c5f09f4)
• synchronizer events not fired when localStorage is disabled (0cfae29)

Features

• options for providing custom state and nonce length (24970cc)