# passport-beam

> Beam (OAuth) authentication strategies for Passport.

Latest version **1.0.4** (published 2016-09-05) · 0 weekly downloads

## Install

```sh
npm install passport-beam
pnpm add passport-beam
yarn add passport-beam
bun add passport-beam
```

## Health

**Score 18/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2016-09-05 |
| First published | 2015-10-03 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/passport-beam) |
| Module format | CommonJS |
| Node | >= 0.4.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | AlfW |
| Maintainers | alfw |
| Keywords | passport, beam, auth, authn, authentication, identity |

## Links

- npm: https://www.npmjs.com/package/passport-beam
- Repository: https://github.com/alfw/passport-beam
- Homepage: https://github.com/alfw/passport-beam#readme
- Issues: https://github.com/alfw/passport-beam/issues
- npm.io page: https://npm.io/package/passport-beam

## Dependencies (2)

- [pkginfo](https://npm.io/package/pkginfo.md) 0.2.x
- [passport-oauth](https://npm.io/package/passport-oauth.md) ~1.x.x

## Alternatives

- [@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
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 1.0.4 (latest) — 2016-09-05
- 1.0.3 — 2015-10-04
- 1.0.2 — 2015-10-04
- 1.0.1 — 2015-10-03
- 1.0.0 — 2015-10-03

## README

# passport-beam
[Passport](http://passportjs.org/) strategies for authenticating with [Beam](https://www.beam.pro/).

This module lets you authenticate using Beam in your Node.js applications.
By plugging into Passport, Beam authentication can be easily and
unobtrusively integrated into any application or framework that supports
[Connect](http://www.senchalabs.org/connect/)-style middleware, including
[Express](http://expressjs.com/).

## Install

    $ npm install passport-beam

#### Configure Strategy

The Beam OAuth authentication strategy authenticates users using a Beam
account and OAuth tokens.  The strategy requires a `verify` callback, which
accepts these credentials and calls `done` providing a user, as well as
`options` specifying a client ID, client secret, and callback URL.

    passport.use(new BeamStrategy({
        clientID: BEAM_CLIENT_ID,
        clientSecret: BEAM_CLIENT_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/beam/callback"
      },
      function(accessToken, refreshToken, profile, done) {
        User.findOrCreate({ beamId: profile.id }, function (err, user) {
          return done(err, user);
        });
      }
    ));

#### Authenticate Requests

Use `passport.authenticate()`, specifying the `'beam'` strategy, to
authenticate requests.

For example, as route middleware in an [Express](http://expressjs.com/)
application:

    app.get('/auth/beam',
      passport.authenticate('beam'));

    app.get('/auth/beam/callback',
      passport.authenticate('beam', { failureRedirect: '/login' }),
      function(req, res) {
        // Successful authentication, redirect home.
        res.redirect('/');
      });

## License

The MIT License (MIT)

Copyright (c) 2015 AlfW

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

---
_Source: https://npm.io/package/passport-beam · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._