@scalekit-sdk/node
v2.12.0
Published
Official Scalekit Node SDK
Readme
📖 Documentation · 🐛 Report an Issue · 💬 Join our Slack
This is the official Node.js SDK for Scalekit, — the auth stack for agents. Build secure AI products faster with authentication for humans (SSO, passwordless, full-stack auth) and agents (MCP/APIs, delegated actions), all unified on one platform. This Node.js SDK enables both traditional B2B authentication and cutting-edge agentic workflows.
Agent-First Features
- Agent Identity — Agents as first-class actors with human ownership and org context
- MCP-Native OAuth 2.1 — Purpose-built for Model Context Protocol with DCR/PKCE support
- Ephemeral Credentials — Time-bound, task-based authorization (minutes, not days)
- Token Vault — Per-User, Per-Tool token storage with rotation and progressive consent
- Human-in-the-Loop — Step-up authentication when risk crosses thresholds
- Immutable Audit — Track which user initiated, which agent acted, what resource was accessed
Human Authentication
- Enterprise SSO — Support for SAML and OIDC protocols
- SCIM Provisioning — Automated user provisioning and deprovisioning
- Passwordless Authentication — Magic links, OTP, and modern auth flows
- Multi-Tenant Architecture — Organization-level authentication policies
- Social Logins — Support for popular social identity providers
- Full-Stack Auth — Complete IdP-of-record solution for B2B SaaS
Getting started
Prerequisites
- Node.js ≥ 18.14.1
- Scalekit account with
env_url,client_id, andclient_secret
installation
npm install @scalekit-sdk/node
# or
yarn add @scalekit-sdk/node
# or
pnpm add @scalekit-sdk/nodeUsage
import { ScalekitClient } from "@scalekit-sdk/node";
const scalekitClient = new ScalekitClient(
process.env.SCALEKIT_ENV_URL!,
process.env.SCALEKIT_CLIENT_ID!,
process.env.SCALEKIT_CLIENT_SECRET!
);
// use scalekitClient to interact with the Scalekit API
const authUrl = scalekitClient.getAuthorizationUrl("https://acme-corp.com/redirect-uri", {
state: "state",
connectionId: "connection_id",
});Example — SSO with Express.js
import express from "express";
import { ScalekitClient } from "@scalekit-sdk/node";
const app = express();
const scalekitClient = new ScalekitClient(
process.env.SCALEKIT_ENV_URL!,
process.env.SCALEKIT_CLIENT_ID!,
process.env.SCALEKIT_CLIENT_SECRET!
);
const redirectUri = `${process.env.HOST}/auth/callback`;
// get the authorization URL and redirect the user to the IdP login page
app.get("/auth/login", (req, res) => {
const authUrl = scalekitClient.getAuthorizationUrl(
redirectUri,
{
state: "state",
connectionId: "connection_id",
}
);
res.redirect(authUrl);
});
// handle the callback from Scalekit
app.get("/auth/callback", async (req, res) => {
const { code, error, error_description, idp_initiated_login } = req.query;
// handle error
if (error) {
return res.status(400).json({ error, error_description });
}
// handle IdP initiated login
if (idp_initiated_login) {
// get the claims from the IdP initiated login
const {
connection_id,
organization_id,
login_hint,
relay_state
} = await scalekitClient.getIdpInitiatedLoginClaims(idp_initiated_login as string);
// get the authorization URL and redirect the user to the IdP login page
const url = scalekitClient.getAuthorizationUrl(
redirectUri,
{
connectionId: connection_id,
organizationId: organization_id,
loginHint: login_hint,
...(relay_state && { state: relay_state }),
}
);
return res.redirect(url);
}
const authResp = await scalekitClient.authenticateWithCode(code, redirectUri);
res.cookie("access_token", authResp.accessToken);
return res.json(authResp.accessToken);
});
app.listen(3000, () => {
console.log("Server is running on port 3000");
});| Framework | Repository | Description | |-----------|------------|-------------| | Express.js | scalekit-express-example | Basic Express.js server implementation | | Next.js | scalekit-nextjs-demo | Modern React/Next.js application | Auth.js | scalekit-authjs-example | Next.js with Auth.js (next-auth v5) |
Full Stack Auth — encrypted-session middleware for Express and Next.js
The example above is for Modular SSO: Scalekit brokers the OAuth exchange with your customer's own IdP via a connectionId, and your app owns its own session however it likes.
If instead Scalekit hosts your login UI and you want it to also manage the session lifecycle for you (Full Stack Auth), @scalekit-sdk/node ships optional Express and Next.js extras that handle the encrypted session cookie, transparent token refresh, CSRF-safe login/callback, and full logout for you — no hand-rolled cookies, no manual refresh timing.
Register these under Dashboard → Authentication → Redirects before testing:
- Redirect URI — your
redirectUri(the/callbackpath). Scalekit rejects the exchange if this doesn't match exactly. - Post Logout Redirect URI — where users land after full logout. A relative path gets auto-absolutized against the request host, but the resulting absolute URL must still be registered.
- Initiate Login URL — your
/loginpath. Scalekit redirects here (not/callback) for a bookmarked login page, an IdP portal tile, or an invite/magic link —loginHandler/createLoginHandleralready handle this correctly, including theidp_initiated_loginquery parameter case, with no extra code required.
npm install @scalekit-sdk/node express # or: npm install @scalekit-sdk/node next// Express
import express from "express";
import ScalekitClient from "@scalekit-sdk/node";
import { ScalekitAuth } from "@scalekit-sdk/node/express";
const client = new ScalekitClient(
process.env.SCALEKIT_ENV_URL,
process.env.SCALEKIT_CLIENT_ID,
process.env.SCALEKIT_CLIENT_SECRET
);
const auth = new ScalekitAuth({
client,
redirectUri: "https://myapp.com/callback",
cookieEncryptionSecret: process.env.COOKIE_ENCRYPTION_SECRET, // openssl rand -base64 32
});
const app = express();
app.use(auth.router); // registers /login, /callback, /logout
app.get("/account", auth.requiresAuth, (req, res) => {
res.json({ sub: req.scalekitUser?.sub });
});// Next.js (App Router) -- one auth instance, constructed once and re-exported
// lib/auth.js
import ScalekitClient from "@scalekit-sdk/node";
import { ScalekitAuthNext } from "@scalekit-sdk/node/next";
const client = new ScalekitClient(
process.env.SCALEKIT_ENV_URL,
process.env.SCALEKIT_CLIENT_ID,
process.env.SCALEKIT_CLIENT_SECRET
);
export const auth = new ScalekitAuthNext({
client,
redirectUri: "https://myapp.com/callback",
cookieEncryptionSecret: process.env.COOKIE_ENCRYPTION_SECRET, // openssl rand -base64 32
});
// app/login/route.js
import { auth } from "../../lib/auth";
export const GET = auth.createLoginHandler();
// app/callback/route.js
import { auth } from "../../lib/auth";
export const GET = auth.createCallbackHandler();
// app/logout/route.js
import { auth } from "../../lib/auth";
export const GET = auth.createLogoutHandler();
// app/account/route.js
import { auth } from "../../lib/auth";
export const GET = auth.withAuth(async (request, { user }) => Response.json({ sub: user?.sub }));req.scalekitUser / user is access-token claims, not an id_token profile. sub is always present; email only appears if you add it as a custom access-token claim in the dashboard.
See examples/express and examples/nextjs for complete, runnable versions. For a fuller production-oriented sample app, see the framework repos in the table above.
createMiddleware() — secure-by-default route protection (Next.js)
Instead of wrapping every protected route with withAuth, createMiddleware() gates every route unless it's explicitly public or part of the auth flow itself — an unlisted route fails closed (redirects to /login?returnTo=<path>, restored after login) instead of open, so no route can be accidentally left unprotected:
// middleware.ts
import { auth } from "./lib/auth";
export default auth.createMiddleware({
publicRoutes: ["/", "/pricing"],
});
// Next.js requires this as a separate, statically-analyzable export --
// parsed at build time, so it can't be generated for you.
export const config = {
runtime: "nodejs", // see ScalekitEdgeClient below for real Edge Runtime
matcher: ["/((?!_next/static|_next/image|favicon.ico).*)"],
};For Server Components, Route Handlers, or Server Actions that just need to read the session without gating the route:
const user = await auth.currentUser(); // Record<string, unknown> | undefined -- never accessToken/refreshToken
const session = await auth.getSession(); // { user, expiresAt } | nullBoth are read-only — they don't refresh an expiring session; only createMiddleware()/withAuth() write a new session cookie.
ScalekitEdgeClient — for Next.js middleware on Edge Runtime
The default ScalekitClient (above) uses a gRPC transport and Node-only APIs, which don't work inside Next.js Edge Runtime middleware. @scalekit-sdk/node/edge exports ScalekitEdgeClient, a fetch + jose-based alternative covering the same auth-flow methods (getAuthorizationUrl, authenticateWithCode, refreshAccessToken, validateToken, getLogoutUrl, getIdpInitiatedLoginClaims) used by ScalekitAuth/ScalekitAuthNext. It's a drop-in client for either adapter — not a general replacement for ScalekitClient, which remains the default for everything else (organizations, connections, directories, etc.).
// lib/auth.js (Next.js middleware, Edge Runtime)
import { ScalekitEdgeClient } from "@scalekit-sdk/node/edge";
import { ScalekitAuthNext } from "@scalekit-sdk/node/next";
const client = new ScalekitEdgeClient(
process.env.SCALEKIT_ENV_URL,
process.env.SCALEKIT_CLIENT_ID,
process.env.SCALEKIT_CLIENT_SECRET
);
export const auth = new ScalekitAuthNext({
client,
redirectUri: "https://myapp.com/callback",
cookieEncryptionSecret: process.env.COOKIE_ENCRYPTION_SECRET,
});See examples/nextjs-edge for a complete, runnable version, including the runtime: 'experimental-edge' middleware config this requires.
Helpful links
Quickstart Guides
- SSO Integration — implement enterprise Single Sign-on
- Full Stack Auth — complete authentication solution
- Passwordless Auth — modern authentication flows
- Social Logins — popular social identity providers
- Machine-to-Machine — API authentication
Documentation & Reference
- API Reference — complete API documentation
- Developer Kit — tools and utilities
- API authentication guide — secure API access
Additional resources
- setup Guide — initial platform configuration
- Code examples — ready-to-use code snippets
- Admin Portal Guide — administrative interface
- Launch Checklist — Pre-production checklist
Contributing
Contributions are welcome! Coming soon: contribution guidelines.
For now:
- Fork this repository
- Create a branch —
git checkout -b fix/my-improvement - Make your changes
- Run tests —
npm test - Open a Pull Request
License
This project is licensed under the MIT license. See the LICENSE file for more information.
