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.4.0.tar.gz (59.6 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.4.0-py3-none-any.whl (71.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for authflow-0.4.0.tar.gz
Algorithm Hash digest
SHA256 456926453af0f07bd42579499ba0f066ad401023d60f24caa1ddb76e0b510be2
MD5 8373c6583c29d622bb6f9b69cbca5b95
BLAKE2b-256 5ee09d3f97abc13f7248d4027306fda32f073f08b4a3e2139426b6563cbaae28

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 71.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for authflow-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9a53afb17f646231dc56906742cbea917c28d6d1e71884265b5f6844b7898a5
MD5 1995246251c451c947abc8a38343c1d2
BLAKE2b-256 959aa88d754f26148161b9d5c25b70d701329d7eb6a421e057942d456e8f4b19

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