Skip to main content
Server SDKs make it easier to interact with our REST API from your server-side code.

​
Installation

npm install @authsignal/node

yarn add @authsignal/node

pnpm add @authsignal/node

bun add @authsignal/node

​
Initialization

Initialize the Authsignal client by providing your tenant’s Server API secret key and the API URL for your region. 
import { Authsignal } from "@authsignal/node";

const authsignal = new Authsignal({
  apiSecretKey: "YOUR_SECRET_KEY",
  apiUrl: "YOUR_API_URL",
});

using Authsignal;

var authsignal = new AuthsignalClient(
    apiSecretKey: "YOUR_SECRET_KEY",
    apiUrl: "YOUR_API_URL"
);

import com.authsignal.AuthsignalClient;

AuthsignalClient authsignal = new AuthsignalClient(
    "YOUR_SECRET_KEY",
    "YOUR_API_URL"
);

require 'authsignal'

Authsignal.setup do |config|
    config.api_secret_key = ENV["YOUR_SECRET_KEY"]
    config.api_url = "YOUR_API_URL"
end

from authsignal.client import AuthsignalClient

authsignal = AuthsignalClient(
    api_secret_key="YOUR_SECRET_KEY",
    api_url="YOUR_API_URL"
)

Authsignal::setApiSecretKey("YOUR_SECRET_KEY");
Authsignal::setApiUrl("YOUR_API_URL");

import "github.com/authsignal/authsignalgo/v2/client"

client := NewAuthsignalClient(
    "YOUR_SECRET_KEY",
    "YOUR_API_URL",
)

​
Regions

The API URLs for each region are defined below.
RegionAPI URL
US (Oregon)https://api.authsignal.com/v1
AU (Sydney)https://au.api.authsignal.com/v1
EU (Ireland)https://eu.api.authsignal.com/v1
CA (Montreal)https://ca.api.authsignal.com/v1

​
Usage

Actions

Users

Authenticators

Challenges

Sessions

Webhooks

Error handling

​
Repositories

Node.js

C#

Java

Ruby

Python

PHP

Go