Highly configurable authentication and authorization package wrapping Keycloak
Project description
authflow - Backend Package
Python/FastAPI backend for authflow-stack.
Installation
pip install authflow
Quick Start
from fastapi import FastAPI, Depends
from authflow import AuthFlow, setup_auth
from authflow.dependencies import get_current_user, require_permission
app = FastAPI()
# Initialize from config file
auth = AuthFlow.from_config("authflow.config.yaml")
setup_auth(app, auth, prefix="/api/v1/auth")
# Protected route
@app.get("/api/data")
async def get_data(user = Depends(get_current_user)):
return {"message": f"Hello {user.username}"}
# Permission-protected route
@app.post("/api/contracts")
@require_permission("contracts:write")
async def create_contract(user = Depends(get_current_user)):
return {"status": "created"}
Configuration
Create authflow.config.yaml:
provider:
type: keycloak
keycloak:
url: https://keycloak.example.com
realm: my-realm
client_id: authflow-client
client_secret: ${KEYCLOAK_SECRET}
features:
organizations: true
teams: true
email_verification: true
rbac:
model: role-based
scopes: [global, organization, team]
Development
pip install -e ".[dev]"
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
authflow-0.3.0.tar.gz
(53.9 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
authflow-0.3.0-py3-none-any.whl
(64.9 kB
view details)
File details
Details for the file authflow-0.3.0.tar.gz.
File metadata
- Download URL: authflow-0.3.0.tar.gz
- Upload date:
- Size: 53.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80542667341b4dc7bb72f390424707ca468cee6e3ae5caaa4361e4936dd6af02
|
|
| MD5 |
c99f1164b08ec7a844be06a16e3405ae
|
|
| BLAKE2b-256 |
a1d81c034f9e4f865d6f4d7298da3c147c364abe11f79fb1760ec9caa8da293d
|
File details
Details for the file authflow-0.3.0-py3-none-any.whl.
File metadata
- Download URL: authflow-0.3.0-py3-none-any.whl
- Upload date:
- Size: 64.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
58104c517ba60bfae3bce4e7c52feb927402deca9d770e281469c14e862d4eb7
|
|
| MD5 |
525d26cfee78a856dbe17ca4376ba5b0
|
|
| BLAKE2b-256 |
624f9a67fd7a55d7da41ce87b7fef1408688bc46e6ac371fed495ceafe499854
|