redux-oidc
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.0-beta1 • Public • Published

    redux-oidc

    Build Status

    A package for managing OpenID-Connect authentication in ReactJS / Redux apps. It wraps the popular oidc-client library to redux actions and reducers.

    Description

    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 or authorization 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

    Installation

    npm install --save redux-oidc

    Peer dependencies

    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.

    babel-polyfill

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

    Version 4 released

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

    Documentation

    You can find the docs for version 3 here:

    Note for react-native users

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

    Version 2

    Check out the wiki for further information for Version 2 (deprecated).

    Sample app

    There is a sample application demonstrating the use of this package here.

    Tests

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

    Install

    npm i redux-oidc

    DownloadsWeekly Downloads

    13,113

    Version

    4.0.0-beta1

    License

    MIT

    Unpacked Size

    353 kB

    Total Files

    22

    Last publish

    Collaborators

    • maxmantz