AuthX

Ready-to-use and customizable Authentications and Oauth2 management for FastAPI ⚡

---

Project	Status
CI
Meta

---

Source Code: https://github.com/yezz123/authx

Documentation: https://authx.yezz.me/

---

Add a fully featured authentication and authorization system to your FastAPI project. AuthX is designed to be simple, customizable, and secure.

Installation

pip install authx

Quick Start

from fastapi import FastAPI, Depends, HTTPException
from authx import AuthX, AuthXConfig

app = FastAPI()

config = AuthXConfig(
    JWT_SECRET_KEY="your-secret-key",  # Change this!
    JWT_TOKEN_LOCATION=["headers"],
)

auth = AuthX(config=config)
auth.handle_errors(app)

@app.post("/login")
def login(username: str, password: str):
    if username == "test" and password == "test":
        token = auth.create_access_token(uid=username)
        return {"access_token": token}
    raise HTTPException(401, detail="Invalid credentials")

@app.get("/protected", dependencies=[Depends(auth.access_token_required)])
def protected():
    return {"message": "Hello World"}

Test it:

# Get a token
curl -X POST "http://localhost:8000/login?username=test&password=test"

# Access protected route
curl -H "Authorization: Bearer <your-token>" http://localhost:8000/protected

Features

• Support for Python 3.9+ and Pydantic 2
• JWT authentication with multiple token locations:
  • Headers (Bearer token)
  • Cookies (with CSRF protection)
  • Query parameters
  • JSON body
• Access and refresh token support
• Token freshness for sensitive operations
• Token blocklist/revocation
• Extensible error handling

Extra Features

Install authx-extra for additional features:

pip install authx-extra

• Redis session store and cache
• HTTP caching
• Performance profiling with pyinstrument
• Prometheus metrics

Note: Check Release Notes.

Contributors and Sponsors

Thanks goes to these wonderful people (emoji key):

Yasser Tahiri 💻 📖 🚧 🚇	Abderrahim SOUBAI-ELIDRISI 👀 📖	Ismail Ghallou 💻 🛡️	MojixCoder 💻 🐛	Stéphane Raimbault 💻 🔌	theoohoho 📖	Yogesh Upadhyay 🐛
Roman 🐛	Alvaro Lopez Ortega 📖	Devy Santo 🚇	pg365 🚇	Jorrit 📦	Callam 💻	Maxim 💻
Suyog Shimpi 💻	NeViNez 🐛	Antareske 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

This project is licensed under the terms of the MIT License.