# passport-discord-token
> Discord access token authentication strategy for Passport
Latest version **2.1.1** (published 2021-05-27) · MIT license · 0 weekly downloads
## Install
```sh
npm install passport-discord-token
pnpm add passport-discord-token
yarn add passport-discord-token
bun add passport-discord-token
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.1.1 |
| Published | 2021-05-27 |
| First published | 2021-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 1 |
| Unpacked size | 13.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rahil Patel |
| Maintainers | rahil-p |
| Keywords | passport, discord, auth, authn, authentication, identity, token |
## Links
- npm: https://www.npmjs.com/package/passport-discord-token
- Repository: https://github.com/rahil-p/passport-discord-token
- Homepage: https://github.com/rahil-p/passport-discord-token#readme
- Issues: https://github.com/rahil-p/passport-discord-token/issues
- npm.io page: https://npm.io/package/passport-discord-token
## Dependencies (1)
- [passport-oauth](https://npm.io/package/passport-oauth.md) ^1.0.0
## Alternatives
- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
## Recent versions
- 2.1.1 (latest) — 2021-05-27
- 2.1.0 — 2021-05-27
- 2.0.0 — 2021-05-27
- 1.0.5 — 2021-05-23
- 1.0.4 — 2021-05-23
- 1.0.3 — 2021-05-23
- 1.0.2 — 2021-05-21
- 1.0.1 — 2021-05-21
- 1.0.0 — 2021-05-21
## README
# passport-discord-token
Passport strategy for authorizing users with Discord access tokens using the OAuth 2.0 API.
This module lets you authenticate using Discord in your Node.js applications.
By plugging into Passport, Discord
authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style
middleware, including Express.
[](https://www.npmjs.com/package/passport-discord-token)
[](https://codecov.io/gh/rahil-p/passport-discord-token)
---
**Note:**
This strategy is primarily intended for authorizing requests from native clients that must obtain a Discord access
token using client-side flows (e.g. Discord Game SDK, PKCE) before authenticating with your Node.js backend.
For browser clients, a strategy like [passport-discord](https://github.com/nicholastay/passport-discord.git) is better
suited.
---
[comment]: <> ()
[comment]: <> ()
## Installation
```shell
npm install passport-discord-token
```
```shell
yarn add passport-discord-token
```
## Usage
### Create an Application
Before using `passport-discord-token`, you must register an application with Discord. If you have not already done so,
create an application in the Discord Developer Portal.
Your application will be issued a client ID, which need to be provided to the strategy.
### Configure Strategy
The strategy requires a `verify` callback, which accepts these credentials and calls `done` providing a `user`, as well
as options specifying a `clientID` and `clientSecret`.
```js
const DiscordTokenStrategy = require('passport-discord-token');
passport.use(new DiscordTokenStrategy({
clientID: DISCORD_CLIENT_ID, /* required */
clientSecret: DISCORD_CLIENT_SECRET, /* optional (supports refresh token exchange) */
}, (accessToken, refreshToken, profile, done) => {
User.findOrCreate({discordId: profile.id}, (error, user) => {
return done(error, user);
});
}));
```
### Authenticate Requests
Use `passport.authenticate()`, specifying the `'discord-token'` strategy, to authenticate requests.
For example, as route middleware in an Express application:
```js
app.post('/auth/discord-token',
passport.authenticate('discord-token'),
(req, res) => {
res.send(req.user ? 200 : 401);
});
```
## Client-Side
### Configure Client
Your client must first obtain an access token from Discord's OAuth 2.0 endpoints before making a request to this
strategy ([_see note_](#note)). Here are some options:
[**Discord Game SDK**](https://discord.com/developers/docs/game-sdk/sdk-starter-guide) - Call
[`ApplicationManager.GetOAuth2Token`](https://discord.com/developers/docs/game-sdk/applications#getoauth2token) to
obtain a token directly from your game.
[**Authorization Code Flow**](https://discord.com/developers/docs/topics/oauth2#authorization-code-grant)
- **with PKCE** ([RFC7636](https://datatracker.ietf.org/doc/html/rfc7636)) - A secure means for obtaining an access
token from a native client. _Although this modified flow is supported by Discord's API, documentation is pending._
[**Implicit Grant**](https://discord.com/developers/docs/topics/oauth2#implicit-grant)
### Client Requests
Clients can send a request to a route that uses the `passport-discord-token` strategy by providing an access token in
the request's body, query parameters, or headers.
**Body:**
```shell
POST /auth/discord-token
access_token=
```
**Query Parameter:**
```shell
GET /auth/discord-token?access_token=
```
**Authorization Header:**
```shell
GET /auth/discord-token
Authorization: Bearer
```
## License
[MIT License](https://github.com/rahil-p/passport-discord-token/blob/master/LICENSE)
---
_Source: https://npm.io/package/passport-discord-token · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._