Skip to main content

simple_module_keycloak

Keycloak OIDC authentication provider for simple_module. Swap with simple_module_users for Keycloak-backed identity management — users, roles, and login all handled by Keycloak.

Install

Add to your app's pyproject.toml dependencies instead of simple_module_users:

dependencies = [
    "simple_module_keycloak==0.0.17",
]

Run uv sync --all-packages to install.

Usage

Set the required environment variables (or configure via the settings admin UI after first boot):

SM_KEYCLOAK_SERVER_URL=https://keycloak.example.com
SM_KEYCLOAK_REALM=my-realm
SM_KEYCLOAK_CLIENT_ID=my-app
SM_KEYCLOAK_CLIENT_SECRET=my-secret

The module auto-registers as the auth provider. Browser users are redirected to Keycloak's hosted login page. Mobile clients authenticate directly with Keycloak and send bearer tokens to the framework API.

Keycloak realm roles are mapped to framework permissions via the role_mapping setting (default: admin and user map 1:1).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_module_keycloak-0.0.32.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_module_keycloak-0.0.32-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file simple_module_keycloak-0.0.32.tar.gz.

File metadata

  • Download URL: simple_module_keycloak-0.0.32.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for simple_module_keycloak-0.0.32.tar.gz
Algorithm Hash digest
SHA256 4314f1e1483cc28900f04a0dee73b4a25388d25345c64e59f964b427d0491067
MD5 d2b31ff1581cfec5a8a5f0b6f3f2acb4
BLAKE2b-256 e4a104121b286361bfc8ea63b59464329980680915c21c2881d1d1cb2b568509

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_keycloak-0.0.32.tar.gz:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file simple_module_keycloak-0.0.32-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_keycloak-0.0.32-py3-none-any.whl
Algorithm Hash digest
SHA256 b69c6d8255c98978cea67f1538e6bc8068ee4f92e866e93fff2317d152b858ce
MD5 f7d56c1b1c7ea4f4f54457c372eb6044
BLAKE2b-256 47b90c6cc1efb6151c266a2358325549086af4a9fb0c2ac3e416ef8ac0c6ca28

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_keycloak-0.0.32-py3-none-any.whl:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.0.33

2 files

This release

0.0.32 This release

2 files

0.0.31

2 files

0.0.30

2 files

0.0.29

2 files

0.0.28

2 files

0.0.27

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page