discord-oauth2-simple
v1.0.4
Published
Discord OAuth2 client for making dashboard and website linked with discord.
Downloads
29
Maintainers
Readme
discord-oauth2-simple
Library for interacting with Discord OAuth2.0, using passport strategy.
Usage
npm install --save discord-oauth2-simple
Configure Strategy
The Discord authentication strategy authenticates users via a Discord user account and OAuth 2.0 token(s). A Discord API client ID, secret and redirect URL must be supplied when using this
strategy. The strategy also requires a verify
callback, which receives the access token and an optional refresh token, as well as a profile
which contains the authenticated Discord
user's profile. The verify
callback must also call cb
providing a user to complete the authentication.
const DiscordStrategy = require('discord-oauth2-simple').Strategy;
const scopes = ['identify', 'email', 'guilds', 'guilds.join'];
passport.use(new DiscordStrategy({
clientID: '',
clientSecret: '',
callbackURL: 'https://mylovely.website/auth/discord/callback',
scope: scopes
},
function(accessToken, refreshToken, profile, cb) {
User.findOrCreate({ discordId: profile.id }, function(err, user) {
return cb(err, user);
});
}));
Authentication Requests
Use passport.authenticate()
, and specify the 'discord'
strategy to authenticate requests.
For example, as a route middleware in an Express app:
app.get('/auth/discord', passport.authenticate('discord')); // Redirects to Discord oauth page.
app.get('/auth/discord/callback', passport.authenticate('discord', {
failureRedirect: '/'
}), function(req, res) {
res.redirect('/anonymous-land') // Successful auth
});
If using the bot
scope, the permissions
option can be set to indicate
specific permissions your bot needs on the server (permission codes):
app.get("/auth/discord", passport.authenticate("discord", { permissions: 66321471 }));
Refresh Token Usage
In some use cases where the profile may be fetched more than once or you want to keep the user authenticated, refresh tokens may wish to be used. A package such as passport-oauth2-refresh
can assist in doing this.
Example:
npm install passport-oauth2-refresh --save
var DiscordStrategy = require('discord-oauth2-simple').Strategy
, refresh = require('passport-oauth2-refresh');
var discordStrat = new DiscordStrategy({
clientID: '656863586756591637',
clientSecret: '-tWPPY8WEJcCLcJzShjb1Y4KyGgyoVue',
callbackURL: 'https://my.website/auth/discord/callback'
},
function(accessToken, refreshToken, profile, cb) {
profile.refreshToken = refreshToken; // store this for later refreshes
User.findOrCreate({ discordId: profile.id }, function(err, user) {
if (err)
return done(err);
return cb(err, user);
});
});
passport.use(discordStrat);
refresh.use(discordStrat);
... then if we require refreshing when fetching an update or something ...
refresh.requestNewAccessToken('discord', profile.refreshToken, function(err, accessToken, refreshToken) {
if (err)
throw; // boys, we have an error here.
profile.accessToken = accessToken; // store this new one for our new requests!
});
Examples
An Express server example can be found in the /example
directory. Be sure to npm install
in that directory to get the dependencies.
License
Licensed under the MIT license. The full license text can be found in the root of the project repository.