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.2.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.2-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 ce8a9be8971839cc782ddf84c6e76115eb67a44f12e60557aa3201b9ed05ec0f
MD5 4d4143c6305bf6feb8bbbc454f06ede9
BLAKE2b-256 5e2586da5b3848f676843a69725f53166622cc9902a41cee26d32487213bafb4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fe479d79ae0aeb9c83db6555be2bdce99c80a281301e8ba6df795726a1726a2f
MD5 fd249820ae91a7e5d8ffb641bfaa3879
BLAKE2b-256 94c66706c54a817b5f3e40fe86c0110d3e50aaf328c475409466ebc89d24aba5

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