Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.36 KB

README.md

File metadata and controls

26 lines (18 loc) · 1.36 KB

Simple Directory - Express

Build Status Coverage Status

Middleware and router helpers to write expressjs applications that depend on simple-directory for authentication.

npm i @data-fair/sd-express

Initialization:

const app = require('express')()
const session = require('@data-fair/sd-express')({directoryUrl: 'http://my-simple-directory'})

// These routes are authenticated. In your router req.user will be defined with the content of the session.
app.use('/api', session.auth, apiRouter)

// These routes can all be used as callback redirections from authentication (thanks to session.loginCallback)
// Also they will have req.user but without the cost of crypto verification and session prolongation (thanks to session.decode)
app.use('/ui', session.loginCallback, session.decode, uiRouter)
// The router exposes login, logout and ping routes to manage auth and session.
app.use('/session', session.router)

TODO: Proper documentation of options and functionalities. For now the code is the doc.