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.5.tar.gz (50.9 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.5-py3-none-any.whl (61.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.2.5.tar.gz
  • Upload date:
  • Size: 50.9 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.5.tar.gz
Algorithm Hash digest
SHA256 93a15d8a4f94ca82b9c31f086d9fc2eca69b31d99096372849d60023e361e952
MD5 8645d471bfcf11894ec5340813cbdafb
BLAKE2b-256 137a844cb5f990994866d7005bc66ac78a378af4c8ae6b7ab73fae7c348fb63f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 61.6 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c70386d3f3302e388659c5bacff8c4beb796e4eceff0e690a1434fa11b7c87f4
MD5 c401260896e97a3cc0e2f44319972761
BLAKE2b-256 89414dcfc5e6a388f07d2884d8acbec620876398069fcc496a7f4386db760189

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