passport-figma

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

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

Install

$ npm install passport-figma

Usage

Create an Application

Before using passport-figma, you must register an application with Figma. If you have not already done so, a new application can be created at Figma My Apps. Your application will be issued a client ID and client secret, which need to be provided to the strategy. You will also need to configure a callback URL which matches the route in your application.

Configure Strategy

The Figma authentication strategy authenticates users using a Figma account and OAuth 2.0 tokens. The client ID and secret obtained when creating an application are supplied as options when creating the strategy. Figma also requires a state to be passed, which you can enable by setting it to true. Lastly, the strategy also requires a verify callback, which receives the access token and optional refresh token, as well as profile which is empty for the time being as Figma has no open profile implemented. The verify callback must call cb roviding a user to complete authentication.

var FigmaStrategy = require('passport-figma').Strategy;
 
passport.use(new FigmaStrategy({
    clientID: FIGMA_CLIENT_ID,
    clientSecret: FIGMA_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/figma/callback",
    state: true
  },
  function(accessToken, refreshToken, profile, cb) {
    console.log(accessToken, refreshToken);
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

Keep in mind you also need to enable the express-session middleware for Figma's state verification to work correctly

Support

Funding

This software is provided to you as open source, free of charge. The time and effort to develop and maintain this project is dedicated by @LiamMartens. If you (or your employer) benefit from this project, please consider a financial contribution. Your contribution helps continue the efforts that produce this and other open source software.

Funds are accepted via PayPal, any amount is appreciated.

License

The MIT License