Naphthalene Possum Management

    passport-tidal

    0.4.2 • Public • Published

    passport-tidal NPM version Build Status Dependency Status Coverage percentage

    Passport strategy for authenticating with Tidal using the OAuth 2.0 API.

    This module lets you authenticate using Tidal in your Node.js applications. By plugging into Passport, Tidal authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

    Install

    $ npm install passport-tidal
    

    Usage

    Create an Application

    Before using passport-tidal, you must be registered with an application on Tidal. Please contact us for more information.

    Configure Strategy

    The Tidal authentication strategy authenticates users using a Tidal account and OAuth 2.0 tokens. The app ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the access token and optional refresh token, as well as profile which contains the authenticated user's Tidal profile. The verify callback must call cb providing a user to complete authentication.

    passport.use(new TidalStrategy({
        clientID: TIDAL_APP_ID,
        clientSecret: TIDAL_APP_SECRET,
        callbackURL: "http://localhost:3000/auth/tidal/callback"
      },
      function(accessToken, refreshToken, profile, cb) {
        User.findOrCreate({ tidalId: profile.id }, function (err, user) {
          return cb(err, user);
        });
      }
    ));

    Authenticate Requests

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

    For example, as route middleware in an Express application:

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

    Examples

    Developers using the popular Express web framework can refer to an example as a starting point for their own web applications.

    License

    Apache-2.0 © TIDAL

    Install

    npm i passport-tidal

    DownloadsWeekly Downloads

    11

    Version

    0.4.2

    License

    Apache-2.0

    Last publish

    Collaborators

    • dainar
    • danmademe