Installation¶

Requirements¶

Python 3.12 up to < 3.15 (see requires-python in the package metadata).
Litestar 2.x (declared as a core dependency).
Advanced Alchemy and SQLAlchemy — used by the default user model and SQLAlchemyUserDatabase.
msgspec — request/response structs for OpenAPI and decoding (pulled in by Litestar usage patterns in your app; the library is msgspec-oriented, not Pydantic).

Install the package from PyPI or your index:

uv add litestar-auth
# or
pip install litestar-auth

Optional extras¶

Extra	Purpose
`redis`	Redis-backed token strategy and Redis JWT denylist / rate limiting helpers.
`oauth`	OAuth flows via `httpx-oauth` and token encryption (`cryptography`).
`totp`	TOTP helpers that need `cryptography` (if not already installed via `oauth`).
`all`	`redis` + `oauth` + `totp`.

uv add "litestar-auth[all]"

Typical stacks¶

JWT / Bearer API

The base install at the top of this page is enough. Configure BearerTransport + JWTStrategy (see Quickstart).

Browser sessions (cookies)

Same core package. Use CookieTransport and set csrf_secret in production. See Cookie + CSRF cookbook.

OAuth, Redis, or TOTP

uv add "litestar-auth[oauth]"   # OAuth
uv add "litestar-auth[redis]"   # Redis strategy, denylist, rate limits
uv add "litestar-auth[totp]"    # TOTP helpers if not already via oauth
# or
uv add "litestar-auth[all]"

What is not included¶

The library does not ship:

Email delivery (use BaseUserManager hooks to call your mailer or queue).
Admin UI or end-user account dashboards.
Built-in RBAC, WebAuthn/passkeys, or audit log storage.

High-level scope and boundaries are on Roadmap.

Building this documentation¶

From the repository root:

just docs-serve   # preview
just docs-build   # static site in site/

Uses Zensical with configuration in zensical.toml.