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

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.2.6.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.6.tar.gz
Algorithm Hash digest
SHA256 4ebc4860ed02e55b05ed9319fa59186258a2f3565883974e8b34be670bb56ed6
MD5 a418e8f0da1e19cc0ea265a503fd48fd
BLAKE2b-256 e620490d29d951b587f825f04c3b02bac78bc706e33cd7f71cf4b6bf6a7bd4f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 61.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.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2d8c2508624580033e729a5f3aa980092d241cc1b74dd12a5a5b2a1e9c56a785
MD5 b9554dfcc847921751dc44884010b1ad
BLAKE2b-256 4762d8dfc844e6af2d91a2307c78256709e067707040e2c91c3de696f3b967a2

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