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.1.7.tar.gz (40.5 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.1.7-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for authflow-0.1.7.tar.gz
Algorithm Hash digest
SHA256 5b77d34da195f4c13f46eebbda50e76ab12bf64e49b880ba661c5a28b589f52e
MD5 203e4d44d33daddac7cf5ba2acaa1072
BLAKE2b-256 01bac340318c6429913a38b6036ea41b4fb890c69c7a5b9885ee22b5c54e0edd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 48.7 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.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 462430613aee48c529e108fdd1fa9606e88c507799e3e3e5e642b70fcb5601fa
MD5 212ac50d7d037c3ff19e0dda549b71c2
BLAKE2b-256 9f58d612b0b8b6eac253cf36b32c5c89d4cd83b788448b93de43c5474384e84d

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