SDK Reference
Zero-dependency, strongly-typed TypeScript client library for AuthOS with comprehensive authentication and multi-tenant management capabilities.
AuthOS SDK
The AuthOS SDK (@drmhse/sso-sdk) is a zero-dependency, strongly-typed TypeScript client library for AuthOS. It provides a clean, programmatic interface for authentication and multi-tenant management.
Getting Started
- Getting Started Guide - Installation and quick start
- Guides - Step-by-step integration guides
SDK Modules
Authentication & Users
- Auth Module -
sso.auth.*- Login, registration, OAuth flows, and device authorization - User Module -
sso.user.*- User profiles, linked identities, and MFA management
Organizations & Services
- Organizations Module -
sso.organizations.*- Organization management, settings, and team administration - Services Module -
sso.services.*- Service configuration, plans, and OAuth settings - Invitations Module -
sso.invitations.*- Team member invitations
Platform Management
- Platform Module -
sso.platform.*- Platform owner administration - Service API Module -
sso.serviceApi.*- Backend service authentication
Integration Guides
Learn how to implement common authentication patterns:
- Authentication Flows - OAuth, Admin, and Device flows
- Password Authentication - Register, login, and password reset
- MFA Management - Enable and verify multi-factor authentication
Installation
npm install @drmhse/sso-sdk
Basic Usage
import { SsoClient } from '@drmhse/sso-sdk';
const sso = new SsoClient({
baseURL: 'http://localhost:3000',
token: localStorage.getItem('sso_access_token')
});
// Login with password
const tokens = await sso.auth.login({
email: 'user@example.com',
password: 'SecurePass123!'
});
// Update client with new token
sso.setAuthToken(tokens.access_token);
Sections
SDK Guides
Step-by-step guides for implementing common authentication and integration patterns with the AuthOS SDK including OAuth, password auth, and MFA.
SDK API Reference
Complete reference documentation for all modules and methods in the AuthOS SDK including authentication, user management, organizations, and services.
Pages
Getting Started with the SDK
Quick start guide for installing and using the AuthOS SDK in JavaScript and TypeScript applications with setup, configuration, and first API calls.
SDK Guides
Step-by-step guides for implementing common authentication and integration patterns with the AuthOS SDK including OAuth, password auth, and MFA.
SDK API Reference
Complete reference documentation for all modules and methods in the AuthOS SDK including authentication, user management, organizations, and services.