uvb-fastapi 0.2.1

FastAPI extension for Universal Verification Broker (UVB)

UVB FastAPI Extension

Official FastAPI extension for Universal Verification Broker (UVB).

Installation

pip install uvb-fastapi

Quick Start

from fastapi import FastAPI, Depends
from uvb import UVBClient
from uvb_fastapi import UVBAuthMiddleware, require_auth, create_uvb_router

app = FastAPI()

# Initialize UVB client
uvb_client = UVBClient(
    tenant_id="your-tenant-id",
    uvb_url="http://localhost:8080"
)
app.state.uvb_client = uvb_client

# Add authentication middleware
app.add_middleware(
    UVBAuthMiddleware,
    tenant_id="your-tenant-id",
    uvb_url="http://localhost:8080",
    exclude_paths=["/health", "/docs", "/auth"],
)

# Include UVB auth routes
auth_router = create_uvb_router(uvb_client)
app.include_router(auth_router)

# Protected route
@app.get("/protected")
async def protected_route(session = Depends(require_auth)):
    return {
        "user_id": session.user_id,
        "factors_verified": session.factors_verified
    }

Features

Middleware

The UVBAuthMiddleware automatically validates sessions on all requests:

app.add_middleware(
    UVBAuthMiddleware,
    tenant_id="your-tenant-id",
    uvb_url="http://localhost:8080",
    exclude_paths=["/health", "/docs"],  # Skip auth for these paths
    token_header="Authorization",         # Header to read token from
    token_prefix="Bearer",                # Token prefix
)

Dependencies

Use FastAPI dependencies for route-level authentication:

from fastapi import Depends
from uvb_fastapi import require_auth, get_current_user

@app.get("/me")
async def get_me(user_id: str = Depends(get_current_user)):
    return {"user_id": user_id}

@app.get("/session")
async def get_session(session = Depends(require_auth)):
    return session.model_dump()

Pre-built Router

The create_uvb_router function provides ready-to-use authentication endpoints:

auth_router = create_uvb_router(uvb_client, prefix="/auth")
app.include_router(auth_router)

This creates:

• POST /auth/verify - Verify user with a factor
• POST /auth/enroll - Enroll a new factor
• GET /auth/factors/{user_id} - List user's factors
• POST /auth/session/validate - Validate a session
• DELETE /auth/session/{session_id} - Revoke a session

Documentation

For more information, see the UVB documentation.

License

MIT