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

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_module_keycloak-0.0.27.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.27.tar.gz
Algorithm Hash digest
SHA256 b5c33b855c71e16c50ac053a6d905f932ed550bcfc64ca6007ed7ab860a1846b
MD5 269666d74d7b362fa125538895fcc767
BLAKE2b-256 75ebea69279c33e148672660f8cf03ff09a699eb746929526171e02dc5dfa029

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_keycloak-0.0.27.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.27-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_keycloak-0.0.27-py3-none-any.whl
Algorithm Hash digest
SHA256 cd639d89d817d667af441f0c313c0d527709736d40b85aada9e2bea562ed2a9e
MD5 f9ed4c067a354f7820cc44897a76c76c
BLAKE2b-256 900267a9d0c111388068c7491499a081b36b6612c070036e13d72d1ba6ea8084

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_keycloak-0.0.27-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

0.0.32

2 files

0.0.31

2 files

0.0.30

2 files

0.0.29

2 files

0.0.28

2 files

This release

0.0.27 This release

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