Key features
The WorkOS Node.js SDK enables you to integrate enterprise features quickly:Single Sign-On (SSO)
Connect to any identity provider with SAML or OAuth 2.0
User Management
Complete authentication system with AuthKit
Directory Sync
Sync user directories from identity providers
Admin Portal
Self-serve configuration for enterprise customers
Audit Logs
Enterprise-grade audit trail for compliance
Multi-Factor Auth
Add MFA to your authentication flows
Fine-Grained Authorization
Implement advanced permission systems
Organizations
Manage multi-tenant organizations
Requirements
Node.js 20.15.0 or higher is required to use this SDK.
- Node.js - 20.15.0+
- Bun - Full support
- Deno - Full support
- Edge runtimes - Cloudflare Workers, Vercel Edge, etc.
Public client mode
For applications that cannot securely store secrets (browser apps, mobile apps, CLI tools), the SDK supports PKCE-based authentication:Getting started
Installation
Install the SDK using your preferred package manager
Quickstart
Get up and running with a simple example
Configuration
Configure the WorkOS client for your application
SDK versioning
WorkOS follows Semantic Versioning (SemVer) for all SDK releases:- Major versions (X.0.0) - Breaking changes
- Minor versions (0.X.0) - New features, backward compatible
- Patch versions (0.0.X) - Bug fixes
Support
Need help? Here are some resources:- Documentation - workos.com/docs
- API Reference - workos.com/docs/reference
- GitHub Issues - github.com/workos/workos-node/issues
- Support - Contact our team at [email protected]