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

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.1.11.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.11.tar.gz
Algorithm Hash digest
SHA256 d74e9cf964f2d19f1d389565d8673dcf29b61ecb8d65f00e4511600e769d77ed
MD5 282cd1d3749b7f6a2b0af2227daf1f40
BLAKE2b-256 f69f9f9adc151cde68523f623338b719979877f0dd4a7b34eeea2fd3c368236b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.1.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 1d8c9d9a247eee19db72126b40f4eed8fd216e6f3ec11edd8bff3438614ae312
MD5 22de32a5c8ba87323618461dcedfc494
BLAKE2b-256 df2bd51107393a618a7315353fd0fba85cfdcf92abde6771aeba32a59a27e45f

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