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

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.2.4.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.4.tar.gz
Algorithm Hash digest
SHA256 143b219f2004cb14e888c98170a01c0c5568ed0534a3c1b89c91958b39d4d099
MD5 047c622a9dbb1409c73787bf581e5b2c
BLAKE2b-256 20c1d7a17dfcc2958e3f0bb58d53ee6be077fdb94354c9866715d43e3a58555b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.2.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b2813e9d211712fd545e6426b75483ee4dd9c86a1b6036a9cbd3cc96d5c2211c
MD5 dba36ebe659100515c3364d0c9952f25
BLAKE2b-256 1881ec5a0558717139bd4613c24432403d769e3157b6e26233ea2e264fdc2c36

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