Options
All
  • Public
  • Public/Protected
  • All
Menu

React-Simple-Auth

styled with prettier Greenkeeper badge Travis Coveralls Dev Dependencies Donate

Simple Authentication for React

Resources

Technical Docs: \ https://mattmazzola.github.io/react-simple-auth/

Getting started

Installation

npm i react-simple-auth

Copy redirect.html

Copy file from /node_modules/react-simple-auth/dist/redirect.html into folder that will service static files. E.g. If you are using create-react-app this will be the public folder. Ensure your OAuth provider is configured to redirect to this html page instead of your normal application / index page.

Create a provider

You would have to look at each OAuth provider's developer documentation for details.

Create a javascript object implementing the IProvider interface.

See the sample for Microsoft AAD v2 OpenID-Connect from the sample project: \ https://github.com/mattmazzola/react-simple-auth-sample/blob/master/src/providers/microsoft.ts

Based on these docs: \ https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols

Call the various methods from the auth service

Import:

import RSA from 'react-simple-auth'
import facebookProvider from './providers/facebook'

Somewhere inside the component:

// Open login window and wait for user to sign in
const session = await RSA.acquireTokenAsync(facebookProvider)

// Invoke Redux login action dispatcher
login(session.userId, session.userName)

Index

External modules

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc