NodeBB/nodebb-plugin-sso-oauth2-multiple
2
0
Fork 0
mirror of https://hk.gh-proxy.com/https://github.com/NodeBB/nodebb-plugin-sso-oauth2-multiple.git synced 2025-10-03 04:21:13 +08:00
Code Issues Projects Packages Wiki Activity Actions

Add lookup endpoint for external services to find users by their own id

Browse source
This commit is contained in:
Christian Schmidt 2024-11-07 02:37:04 +01:00 • committed by Julian Lam
parent abab42d8be
commit 007923d0a9
3 changed files with 20 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -33,9 +33,15 @@ _The role-based access control functionality was sponsored by [Outplayed](https:

## For Developers

### Hooks
Other plugins can interact with this plugin, as it fires the following hooks:

1. On successful login — `action:oauth2.login` — passes in `(name, user, profile)`
* `name` is the strategy name.
* `user` is the local NodeBB user (probably just the `uid`).
* `profile` is the remote profile as retrieved by this plugin.
* `profile` is the remote profile as retrieved by this plugin.

### API
If you need to look up the user from your own system, you can use the GET api route `/api/v3/plugins/oauth2-multiple/provider/:provider/user/:oAuthId`.
* `:provider` must be the name of you OAuth2 strategy
* `:oAuthId` must be the same value that the userinfo endpoint returns for the defined user id

11
lib/controllers.js
View file

@ -8,6 +8,7 @@ const db = require.main.require('./src/database');
const groups = require.main.require('./src/groups');
const slugify = require.main.require('./src/slugify');
const helpers = require.main.require('./src/controllers/helpers');
const userController = require.main.require('./src/controllers/user');

const main = require('../library');

@ -98,3 +99,13 @@ Controllers.deleteStrategy = async (req, res) => {
const strategies = await main.listStrategies();
helpers.formatApiResponse(200, res, { strategies });
};

Controllers.userByOAuthId = async (req, res) => {
const userId = await main.getUidByOAuthid(req.params.provider, req.params.oAuthId);
if (!userId) {
return helpers.formatApiResponse(404, res);
}

const userData = await userController.getUserDataByUID(req.uid, userId);
helpers.formatApiResponse(200, res, { userData });
};

2
library.js
View file

@ -33,6 +33,8 @@ OAuth.addRoutes = async ({ router, middleware }) => {
routeHelpers.setupApiRoute(router, 'post', '/oauth2-multiple/strategies', middlewares, controllers.editStrategy);
routeHelpers.setupApiRoute(router, 'get', '/oauth2-multiple/strategies/:name', middlewares, controllers.getStrategy);
routeHelpers.setupApiRoute(router, 'delete', '/oauth2-multiple/strategies/:name', middlewares, controllers.deleteStrategy);

routeHelpers.setupApiRoute(router, 'get', '/oauth2-multiple/provider/:provider/user/:oAuthId', middlewares, controllers.userByOAuthId);
};

OAuth.addAdminNavigation = (header) => {