API Reference
AuthOS backend API guides and reference material.
API Reference
The AuthOS API is the Rust backend that powers hosted auth, organization management, platform operations, service APIs, and enterprise identity features.
Start here
Key sections
Local defaults
- API base URL:
http://localhost:3001 - Admin dashboard during development:
http://localhost:4000
Use these local defaults only for development and testing. Public deployments should replace them with your own origins.
Sections
API Concepts
Core concepts and architectural patterns of the AuthOS API including JWT authentication, dual flows, and BYOO integration.
7 pagesAPI Reference
Complete endpoint documentation for the AuthOS API including authentication, user management, organizations, services, and integrations.
15 pagesAppendix
Reference materials including error codes, webhook events, JWT claims, and OAuth scopes.
5 pagesPages
Getting Started
Run AuthOS locally and make your first authenticated requests.
Error Handling
Comprehensive guide to error handling patterns, standard response formats, HTTP status codes, and best practices for resilient API integration.
Deployment Guide
Backend deployment notes for AuthOS.
API Concepts
Core concepts and architectural patterns of the AuthOS API including JWT authentication, dual flows, and BYOO integration.
API Reference
Complete endpoint documentation for the AuthOS API including authentication, user management, organizations, services, and integrations.
Appendix
Reference materials including error codes, webhook events, JWT claims, and OAuth scopes.