Repository files navigation

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 handlesOpenID-Connect authentication inredux apps. It enables redux apps to authenticate with an external OIDC authentication provider and handles the actions of the OpenIDimplicit flow orauthorization code 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 wrapsoidc-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 forimmutable.js, if you want to use it.

You need thebabel-polyfill in your build configuration for this package to work.

BREAKING CHANGE:immutable is no longer a dependency. If you are using the immutable reducer, please check out thedocs.

You can find the docs for version 3 here:

• API docs,
• actions,
• example app

This library doesn't fully support react-native apps. Please usethis library instead.

Check out thewiki for further information for Version 2 (deprecated).

There is a sample application demonstrating the use of this packagehere.

You have to install immutableJS for all the tests to pass:npm install immutable --no-save.Then runnpm run test.