Skip to main content

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


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.2.3.tar.gz (50.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

authflow-0.2.3-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

Details for the file authflow-0.2.3.tar.gz.

File metadata

  • Download URL: authflow-0.2.3.tar.gz
  • Upload date:
  • Size: 50.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for authflow-0.2.3.tar.gz
Algorithm Hash digest
SHA256 0c8b3e5ff2d4d9db382be8abb43b55203833a928ee0a5176e0bfe823b055cd4b
MD5 fab5239d73b656ada41ac30a5db747c8
BLAKE2b-256 8fa67eb68a989f15cbfd2c07b787641c0ce47f6166465c6442c5c2b7a0efad96

See more details on using hashes here.

File details

Details for the file authflow-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: authflow-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 61.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for authflow-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a819632f9dba81a596792d5967124e3eecedce994fb0213e036ddf51d0e927cc
MD5 27705dad9a974c0da39b203deb62c69e
BLAKE2b-256 ac8d68702a7bffceba3b932af1764c7d5664774eb726313b815b616b84a8ee85

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page