Install Auth SDK

Learn how to configure the Wristband SDK for your Express application.

Installation

Install the Wristband Auth SDK using your preferred package manager CLI:

npm install @wristband/express-auth
yarn add @wristband/express-auth
pnpm add @wristband/express-auth

Configuration

Prerequisites

Before you can configure the SDK, you'll need to make sure you have the following values:

  • WRISTBAND_APPLICATION_VANITY_DOMAIN
  • WRISTBAND_CLIENT_ID
  • WRISTBAND_CLIENT_SECRET

If you went through the Set Up a Wristband Application guide, you should have been presented with these three values after the application was provisioned. If you don't have the above values on hand, you can retrieve them from the Wristband dashboard by following the steps in this guide.

Configure The SDK

Create an instance of WristbandAuth in the source root directory of your Express project (e.g.src/wristband-auth.ts). Update the AuthConfig properties with the values for your application.

// wristband-auth.ts

import { createWristbandAuth } from '@wristband/express-auth';

const authConfig = {
  clientId: '<WRISTBAND_CLIENT_ID>',
  clientSecret: '<WRISTBAND_CLIENT_SECRET>',
  wristbandApplicationVanityDomain: '<WRISTBAND_APPLICATION_VANITY_DOMAIN>',
};

export const wristbandAuth = createWristbandAuth(authConfig);


What’s Next

Next, you'll use the Wristband SDK to create the necessary authentication endpoints in your Express server.