/
Contact usSee pricingStart building
Node
​

    About Stytch

    Introduction
    Integration Approaches
      Full-stack overview
      Frontend (pre-built UI)
      Frontend (headless)
      Backend
    Migrations
      Migration overview
      Migrating users statically
      Migrating users dynamically
      Additional migration considerations
      Zero-downtime deployment
      Defining external IDs for users
      Exporting from Stytch
    Custom Domains
      Overview

    Authentication

    DFP Protected Auth
      Overview
      Setting up DFP Protected Auth
      Handling challenges
    Magic Links
    • Email Magic Links

      • Getting started with the API
        Getting started with the SDK
        Replacing your password reset flow
        Building an invite user flow
        Add magic links to an existing auth flow
        Adding PKCE to a Magic Link flow
        Magic Link redirect routing
    • Embeddable Magic Links

      • Getting started with the API
    MFA
      Overview
      Backend integration
      Frontend integration
    Mobile Biometrics
      Overview
    M2M Authentication
      Authenticate an M2M Client
      Rotate client secrets
      Import M2M Clients from Auth0
    OAuth
    • Identity providers

      • Overview
        Provider setup
      Getting started with the API (Google)
      Add Google One Tap via the SDK
      Email address behavior
      Adding PKCE to an OAuth flow
    Connected AppsBeta
      Setting up Connected Apps
      About Remote MCP Servers
    • Resources

      • Integrate with AI agents
        Integrate with MCP servers
        Integrate with CLI Apps
    Passcodes
      Getting started with the API
      Getting started with the SDK
    • Toll fraud

      • What is SMS toll fraud?
        How you can prevent toll fraud
      Unsupported countries
    Passkeys & WebAuthn
    • Passkeys

      • Passkeys overview
        Set up Passkeys with the frontend SDK
    • WebAuthn

      • Getting started with the API
        Getting started with the SDK
    Passwords
      Getting started with the API
      Getting started with the SDK
      Password strength policy
    • Email verification

      • Overview
        Email verification before password creation
        Email verification after password creation
    Sessions
      How to use sessions
      Backend integrations
      Frontend integrations
      Custom claims
      Custom claim templates
      Session tokens vs JWTs
      How to use Stytch JWTs
    TOTP
      Getting started with the API
      Getting started with the SDK
    Web3
      Getting started with the API
      Getting started with the SDK

    Authorization

    Implement RBAC with metadata

    3rd Party Integrations

    Planetscale
    Supabase
    Feathery
    Unit

    Testing

    E2E testing
    Sandbox values
Get support on SlackVisit our developer forum

Contact us

Consumer Authentication

/

Guides

/

3rd Party Integrations

/

Planetscale

Stytch and Planetscale for user authentication

Use Stytch and Planetscale to build out your entire user authentication flow and database.

Stytch and Planetscale

Step 1: Create your Planetscale user database

Create your user database with Planetscale's pscale command line utility, then create your first database branch.

$ pscale auth login
$ pscale database create <database-name>
$ pscale branch create <database-name> <branch-name>

Step 2: Create your users table

This query will create your users table where you’ll store a record for each user that is created.

$ pscale shell <database-name> <branch-name> // Open a MYSQL shell in your database.

CREATE TABLE users (
  id int NOT NULL AUTO_INCREMENT PRIMARY KEY,
  name varchar(255),
  email varchar(255) NOT NULL
);

Step 3: Create a deploy request, deploy and merge

$ pscale deploy-request create <database-name> <branch-name>
$ pscale deploy-request deploy <database-name> <deploy-request-number>

Step 4: Create your backend

Establish a connection to the Planetscale, then create the functions to add, remove, and get users from the DB.

const URL = process.env.DATABASE_URL as string;
const sqlConn = mysql.createConnection(URL);
sqlConn.connect();


// getUsers retrieve all users.
async function getUsers(conn: PSDB, req: NextApiRequest, res: NextApiResponse) {
  try {
    var query = 'select * from users';

    const [getRows, _] = await conn.query(query, '');
    res.status(200).json(getRows);
  } catch (error) {
    console.error(error);
    res.status(500).json({ error: 'an error occurred' });
  }
  return;
}

// addUser create a new user.
async function addUser(conn: PSDB, req: NextApiRequest, res: NextApiResponse) {
  var user = JSON.parse(req.body);
  try {
    var query = 'INSERT INTO users (name, email) VALUES (?,?)';
    var params = [name, email];

    var insertID;
    const result = sqlConn.query(query, params, (err, result) => {
      if (err) {
        throw err;
      }

      insertID = (<OkPacket>result).insertId;
    });

    res.status(201).json({ id: insertID });
  } catch (error) {
    console.error(error);
    res.status(500).json({ error: 'an error occurred' });
  }
  return;
}



// deleteUser remove a single user.
async function deleteUser(conn: PSDB, req: NextApiRequest, res: NextApiResponse) {
  try {
    var query = 'DELETE from users WHERE id=?';
    var params = [req.query['uid']];

    var status = 200;

    const result = await sqlConn
      .promise()
      .query(query, params)
      .then(([row]) => {
        if ((<OkPacket>row).affectedRows == 0) {
          status = 304;
        }
      });

    res.status(status).json({ message: 'success' });
  } catch (error) {
    console.error(error);
    res.status(500).json({ error: 'an error occurred' });
  }
  return;
}

Step 5: Instantiate the Stytch client

Instantiate the Stytch client via our stytch-node Backend SDK; you’ll use this SDK to make any calls to the Stytch API. After the user has been authenticated, you will redirect them to the logged-in page where they can take authenticated action.

import * as stytch from 'stytch';

let client: stytch.Client;
const loadStytch = () => {
  if (!client) {
    client = new stytch.Client({
      project_id: process.env.STYTCH_PROJECT_ID || '',
      secret: process.env.STYTCH_SECRET || '',
      env: process.env.STYTCH_PROJECT_ENV === 'live' ? stytch.envs.live : stytch.envs.test,
    });
  }

  return client;
};

Step 6: Setup Stytch Email Magic Links

We would like to be able to invite and add new users to our dashboard, we'll leverage our stytch-node Backend SDK to send Email Magic Links to users to do that.

async function inviteUser(req: NextApiRequest, res: NextApiResponse) {
  const client = loadStytch();

  var email = req.body.email;

  // Params are of type stytch.LoginOrCreateRequest.
  const params = {
    email: email,
    login_magic_link_url: `${BASE_URL}/api/authenticate_magic_link`,
    signup_magic_link_url: `${BASE_URL}/api/authenticate_magic_link`,
  };

  try {
    await client.magicLinks.email.loginOrCreate(params);
    res.status(200).json({"message":"magic link sent"});
  } catch (error) {
    res.status(400).json({ error });
  }
  return;
}

Step 7: Authenticate Email Magic Links

Next you’ll want a way to authenticate the magic links that are being sent by the Stytch SDK.

import type { NextApiRequest, NextApiResponse } from 'next';
import loadStytch from '../../lib/loadStytch';
import { serialize } from 'cookie';


async function authenticate(req: NextApiRequest, res: NextApiResponse) {
  const client = loadStytch();
  const { token } = req.query;

  try {
    // Authenticate request and create 7 day session.
    const resp = await client.magicLinks.authenticate(token as string, { session_duration_minutes: 10080 });

    // Send user to profile with cookies in response.
    res.setHeader(
      'Set-Cookie',
      serialize(process.env.COOKIE_NAME as string, resp.session_token as string, { path: '/' }),
    );
    res.redirect('/profile');
    return;
  } catch (error) {
    res.status(400).json({ error });
    return;
  }
}

Step 8: Setup Session Management

Now that we’ve got authentication in place, what happens when a user leaves and then comes back? We want that returning user to come back to an authenticated experience, so we will use Stytch’s Session Management API to make that happen.

export async function validSessionToken(token: string): Promise<boolean> {
  // Authenticate the session.
  try {
    const sessionAuthResp = await client.sessions.authenticate({
      session_token: token
    });

    if (sessionAuthResp.status_code != 200) {
      console.error('Failed to validate session');
      return false;
    }
    return true;
  } catch (error) {
    console.error(error);
    return false;
  }
}

// Add this session helper to each DB handler so we can prevent unauthenticated API calls.
var isValidSession = await validSessionToken(token);
if (!isValidSession) {
  res.status(401).json({ error: 'user unauthenticated' });
  return;
}

Step 9: Handle clearing sessions

Now we’ll want to add logic to clear the client state once a session has expired. Doing so will allow us to gracefully re-prompt the user to log in when their session expires; when we initiated the session, we chose a session_duration_minutes of 10080 minutes, 7 days, so that users won’t be prompted to re-login if they return within that 7 day period.

export async function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
  if (req.method === 'POST') {
    try {
      //  You can add logic to destroy other sessions or cookies as well.
      res
        .status(200)
        .setHeader('Set-Cookie', [
          serialize(process.env.COOKIE_NAME as string, '', { path: '/', maxAge: -1 }),
          serialize(STYTCH_SESSION_NAME, '', { path: '/', maxAge: -1 }),
        ]).json({"message":"logged out"});
      } catch (error) {
      res.status(400).json({ error });
    }
    return;
  }
}

Step 10: You're Done!

You just finished all the critical backend components in our example. Your app can now login with Stytch Email Magic Links, manage sessions via Sessions Management, and maintain your user database via Planetscale. You can find an example of this implementation in our Stytch + Planetscale example app.

We can’t wait to see what you build with Stytch! Get in touch with us and tell us what you think in our forum, support@stytch.com, or in our community Slack.

Step 1: Create your Planetscale user database

Step 2: Create your users table

Step 3: Create a deploy request, deploy and merge

Step 4: Create your backend

Step 5: Instantiate the Stytch client

Step 6: Setup Stytch Email Magic Links

Step 7: Authenticate Email Magic Links

Step 8: Setup Session Management

Step 9: Handle clearing sessions

Step 10: You're Done!