Getting Started

Run AuthOS locally and make your first authenticated requests.

Updated May 10, 2026 Edit this page

Getting Started

This guide gets a local AuthOS stack running and points you at the most important first requests.

Prerequisites

  • Rust stable
  • Node.js 18+
  • Docker with docker compose

Start the backend

From the repo root:

npm run dev

This starts:

  • API: http://localhost:3001
  • PostgreSQL: localhost:5433
  • Mailpit: http://localhost:8025

Start the admin dashboard

cd web-client
npm install
npm run dev

The dashboard runs on http://localhost:4000.

First useful endpoints

Health

curl http://localhost:3001/health
curl http://localhost:3001/health/ready

Hosted auth context

curl "http://localhost:3001/api/auth/context?org=acme-corp&service=main-app&redirect_uri=http://localhost:4000/callback"

Password login

curl -X POST http://localhost:3001/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "SecurePass123!",
    "org_slug": "acme-corp",
    "service_slug": "main-app"
  }'

Next steps