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.1.tar.gz (50.1 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.1-py3-none-any.whl (60.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.2.1.tar.gz
  • Upload date:
  • Size: 50.1 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.1.tar.gz
Algorithm Hash digest
SHA256 cfda53da5d40d0a9ce0ae45b650f614933c8d1ce673e6e848c1900068014d000
MD5 8d0d0bb6fcc73bda6522bead0e891cd6
BLAKE2b-256 28cb11f22501eaf4be8a474b3c4cb534c9966fcd0cd2be08e5fb960bacf4e53e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 60.9 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 47b8d80617ccc046c116a7c412a69e2bec72ef1649ea4ab9071b009a670822f1
MD5 76a07fee9d7409997a50fb396d37dc46
BLAKE2b-256 1d8b67bb654650767cace778db68d17614c10c22e9fdff0d6ac7bc16de2350d6

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