Constructor
+ + + +new ExpressOAuthServer(optionsopt)
+ + + + + + +Creates a new OAuth2 server that will be bound to this class' middlewares.
+Constructor takes several options as arguments.
+The following describes only options, specific to this module.
+For all other options, please read the docs from @node-oauth/oauth2-server:
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
+
+
+ + + +object + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ optional options +Properties+ + +
|
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
Example
+ +const bodyParser = require('body-parser');
+const express = require('express');
+const OAuthServer = require('@node-oauth/express-oauth-server');
+
+const app = express();
+
+app.oauth = new OAuthServer({
+ model: {}, // See https://github.com/node-oauth/node-oauth2-server for specification
+});
+
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({ extended: false }));
+app.use(app.oauth.authorize());
+
+app.use(function(req, res) {
+ res.send('Secret area');
+});
+
+app.listen(3000);Methods
+ + + + + + + +authenticate(optionsopt) → {function}
+ + + + + + +Authentication Middleware. +Returns a middleware that will validate a token.
+Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +object + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ will be passed to the authenticate-handler as options, see linked docs |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
Returns:
+ + + + +-
+
- + Type + +
- + +function + + + +
authorize(optionsopt) → {function}
+ + + + + + +Authorization Middleware. +Returns a middleware that will authorize a client to request tokens.
+Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +object + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ will be passed to the authorize-handler as options, see linked docs |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
Returns:
+ + + + +-
+
- + Type + +
- + +function + + + +
token(optionsopt) → {function}
+ + + + + + +Grant Middleware. +Returns middleware that will grant tokens to valid requests.
+Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +object + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ will be passed to the token-handler as options, see linked docs |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
Returns:
+ + + + +-
+
- + Type + +
- + +function + + + +
