API Reference

The AuthOS API is a RESTful API built with Rust and Axum, providing comprehensive authentication and multi-tenant management capabilities.

Getting Started

New to the API? Start here:

• Getting Started Guide - Quick start with authentication and first requests
• Concepts - Understand key architectural concepts
• Error Handling - Learn how to handle API errors

API Sections

Authentication & Users

• Authentication - Registration, login, OAuth flows, and device authorization
• User Management - User profiles, identities, and MFA

Organizations & Services

• Organizations - Multi-tenant organization management, SMTP, domains, and branding
• Services - Service configuration and OAuth settings
• Invitations - Team member invitations and onboarding

Security & Access Control

• API Keys - Service-to-service authentication
• Service API - Backend API endpoints for services
• SAML - SAML 2.0 Identity Provider

Governance & Integration

• Audit Logs - Activity tracking and compliance
• Webhooks - Real-time event notifications
• Platform Management - Platform owner administration
• Integrations - Third-party integrations (Stripe)

Base URL

http://localhost:3000

For production deployments, replace with your deployed API URL.

Authentication

The API uses JWT-based authentication. Most endpoints require an Authorization header:

Authorization: Bearer <access_token>

See the Authentication reference for details on obtaining access tokens.