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.8.tar.gz (51.3 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.8-py3-none-any.whl (62.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: authflow-0.2.8.tar.gz
  • Upload date:
  • Size: 51.3 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.8.tar.gz
Algorithm Hash digest
SHA256 54ecfbd0d0608bfd4bc1d02deba965daac483db0c71d2d9626999b49a5e8ee8a
MD5 5d282c7f2d94d6d4673e129d6c26bba2
BLAKE2b-256 0e27847445922117b57daebfe80b53cf41b2dce4894775fc2764e47ac8bd0e99

See more details on using hashes here.

File details

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

File metadata

  • Download URL: authflow-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 62.1 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8ae787fe9ee82abdf955748a79fdd2a65e4596f7090a6b7c2d768afa13c7ac63
MD5 0e3bda1d8dd6daf035d5e3ca482996a2
BLAKE2b-256 a147e83b6e45da0e4f7b1e7203a09ea6a242b9fc366121e705814a7d1f55ded9

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