Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/authts/oidc-client-ts
OpenID Connect (OIDC) and OAuth2 protocol support for browser-based JavaScript applications
https://github.com/authts/oidc-client-ts
oidc oidc-client typescript
Last synced: 13 days ago
JSON representation
OpenID Connect (OIDC) and OAuth2 protocol support for browser-based JavaScript applications
- Host: GitHub
- URL: https://github.com/authts/oidc-client-ts
- Owner: authts
- License: apache-2.0
- Created: 2021-07-12T13:50:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T13:48:58.000Z (24 days ago)
- Last Synced: 2024-10-20T07:43:01.028Z (22 days ago)
- Topics: oidc, oidc-client, typescript
- Language: TypeScript
- Homepage: https://authts.github.io/oidc-client-ts/
- Size: 48.2 MB
- Stars: 1,365
- Watchers: 26
- Forks: 207
- Open Issues: 86
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oidc-client-ts
[](https://npm.im/oidc-client-ts)
[](https://github.com/authts/oidc-client-ts/actions/workflows/ci.yml)
[](https://app.codecov.io/gh/authts/oidc-client-ts)
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.
This project is a fork of
[IdentityModel/oidc-client-js](https://github.com/IdentityModel/oidc-client-js)
which halted its development in June 2021. It has since been ported to
TypeScript here with a similar API for the initial 2.0 release. Going forward,
this library will focus only on protocols that continue to have support in
[OAuth 2.1](https://oauth.net/2.1/). As such, the implicit grant is not
supported by this client. Additional migration notes from `oidc-client` are
available [here](docs/migration.md).
**Contributions and help are greatly appreciated!**
Implements the following OAuth 2.0 protocols and supports
[OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html):
- [Authorization Code Grant with Proof Key for Code Exchange (PKCE)](docs/protocols/authorization-code-grant-with-pkce.md)
- [Authorization Code Grant](docs/protocols/authorization-code-grant.md)
- [Resource Owner Password Credentials (ROPC) Grant](docs/protocols/resource-owner-password-credentials-grant.md)
- [Refresh Token Grant](docs/protocols/refresh-token-grant.md)
- [Silent Refresh Token in iframe Flow](docs/protocols/silent-refresh-token-in-iframe-flow.md)
## Table of Contents
- [Documentation](https://authts.github.io/oidc-client-ts/)
- [Installation](#installation)
- [Building the Source](#building-the-source)
- [Contributing](#contributing)
- [License](#license)
## Installation
Using [npm](https://npmjs.org/)
```sh
$ npm install oidc-client-ts --save
```
## Building the Source
```sh
$ git clone https://github.com/authts/oidc-client-ts.git
$ cd oidc-client-ts
$ npm install
$ npm run build
```
### Running the Sample
**Parcel project**
```sh
$ cd samples/Parcel
$ npm install
$ npm run start
```
and then browse to [http://localhost:1234](http://localhost:1234).
**Angular app**
can be found [here](https://github.com/authts/sample-angular-oidc-client-ts).
### Running the Tests
```sh
$ npm test
```
## Contributing
We appreciate feedback and contribution to this repo!
## License
This project is licensed under the Apache-2.0 license. See the
[LICENSE](https://github.com/authts/oidc-client-ts/blob/main/LICENSE) file for
more info.