# oidc-client

> OpenID Connect (OIDC) & OAuth2 client library

Latest version **1.11.5** (published 2021-02-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install oidc-client
pnpm add oidc-client
yarn add oidc-client
bun add oidc-client
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.11.5 |
| Published | 2021-02-17 |
| First published | 2015-06-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 18.5 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2422 |
| Author | Brock Allen & Dominick Baier |
| Maintainers | brockallen |

## Links

- npm: https://www.npmjs.com/package/oidc-client
- Repository: https://github.com/IdentityModel/oidc-client-js
- Issues: https://github.com/IdentityModel/oidc-client-js/issues
- npm.io page: https://npm.io/package/oidc-client

## Dependencies (5)

- [acorn](https://npm.io/package/acorn.md) ^7.4.1
- [core-js](https://npm.io/package/core-js.md) ^3.8.3
- [base64-js](https://npm.io/package/base64-js.md) ^1.5.1
- [crypto-js](https://npm.io/package/crypto-js.md) ^4.0.0
- [serialize-javascript](https://npm.io/package/serialize-javascript.md) ^4.0.0

## Recent versions

- 1.11.5 (latest) — 2021-02-17
- 1.11.6-beta.1 (beta) — 2021-07-19
- 1.11.4 — 2021-02-13
- 1.11.3 — 2021-01-30
- 1.11.2 — 2021-01-30
- 1.11.1 — 2021-01-30
- 1.11.0 — 2021-01-29
- 1.11.0-beta.2 — 2020-10-04
- 1.11.0-beta.1 — 2020-08-05
- 1.10.1 — 2019-12-18
- 1.10.0 — 2019-12-16
- 1.10.0-beta.2 — 2019-12-02
- 1.10.0-beta.1 — 2019-10-23
- 1.9.1 — 2019-08-31
- 1.9.0 — 2019-08-15
- … 72 more at https://npm.io/package/oidc-client/versions

## README

[![npm package](https://badge.fury.io/js/oidc-client.svg)](https://www.npmjs.com/package/oidc-client)

# oidc-client

Library to provide OpenID Connect (OIDC) and OAuth2 protocol support for client-side, browser-based JavaScript client applications. 
Also included is support for user session and access token management.

## Install

##### Node.js

Node.js v4.4 or later required.

##### NPM

`npm install oidc-client --save`

**NOTE**: if you're not already using [babel-polyfill](https://www.npmjs.com/package/babel-polyfill) make sure you run
`npm install --save babel-polyfill` as well. Then include it in your build.

##### CommonJS
If you don't use a package manager or a module loader, then you can get the library from the `dist` folder on github [here](dist).

## Including in the browser

If you intend to use this library directly in a browser and are not using UMD/AMD then there is a compiled version in the [~/dist](dist) folder. 
It is already bundled/minified and contains the necessary dependencies and polyfills (mainly for ES6 features such as Promises).

If you are using UMD/AMD and/or you already have included an ES6 polyfill (such as babel-polyfill.js) then you can include the UMD packaged version of the file from the [~/lib](lib) folder.

## Building the Source

```
git clone https://github.com/IdentityModel/oidc-client-js.git
cd oidc-client-js
npm install
npm run build
```

## Running the Sample

`npm start`

and then browse to [http://localhost:15000](http://localhost:15000).

## Running the Tests

`npm test`

## Docs

Some initial docs are [here](https://github.com/IdentityModel/oidc-client-js/wiki).

## Feedback, Feature requests, and Bugs

All are welcome on the [issue tracker](https://github.com/IdentityModel/oidc-client-js/issues).

---
_Source: https://npm.io/package/oidc-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._