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.9.tar.gz (51.4 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.9-py3-none-any.whl (62.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.2.9.tar.gz
  • Upload date:
  • Size: 51.4 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.9.tar.gz
Algorithm Hash digest
SHA256 096224e43adfa1780b3e51024835331e0b97a25472373b07496d2447376885a6
MD5 9f386d162764bd6eb004928b194580b2
BLAKE2b-256 44bffbf517cde1a2cac64cca2a7dc9a97dd7d413a536a904009e15cf571a4c6d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 62.1 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 36c60d5c6a37c03b0ed9eab82a0a79d93e5f955ee6ab27d02f22ace30dfd1740
MD5 eaab18e1f9909208cf65614cfd430dc9
BLAKE2b-256 de6dd365bed5c02d001c307526071bfae0ef6a59ab77089868ea3e4e18fa96fd

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