Skip to content

authsignal/authsignal-node

Repository files navigation

Authsignal

Authsignal Node.js SDK

NPM version License

The official Authsignal Node.js library for server-side applications. Use this SDK to easily integrate Authsignal's multi-factor authentication (MFA) and passwordless features into your Node.js backend.

Installation

Using npm:

npm install @authsignal/node

Using yarn:

yarn add @authsignal/node

Using pnpm:

pnpm add @authsignal/node

Using bun:

bun add @authsignal/node

Getting Started

Initialize the Authsignal client with your secret key from the Authsignal Portal and the API URL for your region.

import { Authsignal } from "@authsignal/node";

// Initialize the client
const authsignal = new Authsignal({
  apiSecretKey: process.env.AUTHSIGNAL_SECRET_KEY,
  apiUrl: process.env.AUTHSIGNAL_API_URL, // Use region-specific URL
});

API URLs by Region

Region API URL
US (Oregon) https://api.authsignal.com/v1
AU (Sydney) https://au.api.authsignal.com/v1
EU (Dublin) https://eu.api.authsignal.com/v1

License

This SDK is licensed under the MIT License.

Documentation

For more information and advanced usage examples, refer to the official Authsignal Server-Side SDK documentation.