passport-docusign

    1.3.0 • Public • Published

    The Official DocuSign Passport package

    NPM version NPM downloads Build status

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

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

    Requirements

    Node 0.8 or later.

    Install

    $ npm install passport-docusign
    

    Usage

    Register your Application

    Before using passport-docusign, you must register an application with DocuSign. If you have not already done so, a new application can be created at DocuSign Developers.

    Configure Strategy

    The DocuSign authentication strategy authenticates users using a DocuSign 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 DocuSign profile. The verify callback must call cb providing a user to complete authentication.

    passport.use(new DocusignStrategy({
        clientID: DOCUSIGN_INTEGRATOR_KEY,
        clientSecret: DOCUSIGN_APP_SECRET,
        callbackURL: "http://localhost:3000/auth/docusign/callback"
      },
      function(accessToken, refreshToken, profile, cb) {
        User.findOrCreate({ email: profile.email }, function (err, user) {
          return cb(err, user);
        });
      }
    ));

    Authenticate Requests

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

    For example, as route middleware in an Express application:

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

    Examples

    See https://github.com/docusign/docusign-code-examples/blob/master/node/NodeSDKSamples.js#L32.

    FAQ

    How do I use passport-docusign in production?

    All you need to do is turn the 'production' flag to true.

    app.get('/auth/docusign',
      passport.authenticate('docusign', { production: true }));

    Contributing

    Tests

    The test suite is located in the test/ directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing:

    $ make test

    Coverage

    The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing:

    $ make test-cov
    $ make view-cov

    License

    The MIT License

    Install

    npm i passport-docusign

    DownloadsWeekly Downloads

    1,219

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    15.8 kB

    Total Files

    9

    Last publish

    Collaborators

    • dsdevcenter