A package for managing OpenID-Connect authentication in ReactJS / Redux apps. It wraps the popular oidc-client library to redux actions and reducers.
This package handles OpenID-Connect authentication in redux apps. It enables redux apps to authenticate with an external OIDC authentication provider and handles the actions of the OpenID implicit flow.
It uses the oidc-client-js library to manage OpenID Connect functionality.
It contains the following parts:
- CallbackComponent: A react component processing the signin callback from the OpenID-Connect provider,
- SignoutCallbackComponent: A react component processing the signout callback from the OpenID-Connect provider,
- reducers & actions: reducers and actions to handle OIDC events,
- helpers: create helpers to manage the oidc-client-js library
npm install --save redux-oidc
This package wraps oidc-client-js to use with ReactJS / Redux apps. Install oidc-client like this:
npm install --save oidc-client
In addition there is a peer dependency for immutable.js, if you want to use it.
You need the babel-polyfill in your build configuration for this package to work.
I've decided to overhaul the API of this library. The main changes include:
- removed
childContextfrom the<OidcProvider />, user manager now must be passed in as a prop, - immutablejs is now an optional dependency and doesn't need to be installed for those not using it,
- dropped support for
shouldValidate- the middleware now always validates the user, - dropped support for
triggerAuthFlow- this must now be initiated by a custom action (see example app), - cleaner API all around
The example app is already updated to reflect these changes.
You can find the docs for version 3 here:
This library doesn't fully support react-native apps. Please use this library instead.
Check out the wiki for further information for Version 2 (deprecated).
There is a sample application demonstrating the use of this package here.
npm run test