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.28.tar.gz (10.5 kB view details)

Uploaded Aug 7, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

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

Uploaded Aug 7, 2026 Python 3

File details

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

File metadata

Download URL: simple_module_keycloak-0.0.28.tar.gz
Upload date: Aug 7, 2026
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.28.tar.gz
Algorithm	Hash digest
SHA256	`8024196d301a49aaf1a4c6a9ab77007106562fbac30bfa14f31afc555afa6ade`
MD5	`bfcffd35bd0408dc254b527d33352a8c`
BLAKE2b-256	`830ea59793f8eb7597a0bba16d36764e87374dd833ace55bd46b1c59d19b78b6`

See more details on using hashes here.

Provenance

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: simple_module_keycloak-0.0.28.tar.gz
- Subject digest: 8024196d301a49aaf1a4c6a9ab77007106562fbac30bfa14f31afc555afa6ade
- Sigstore transparency entry: 2373033415
- Sigstore integration time: Aug 7, 2026
Source repository:
- Permalink: antosubash/simple_module_python@8aa4ac120ac7d9aaf8d92d1086e39b9dd3a7fdd1
- Branch / Tag: refs/heads/main
- Owner: https://github.com/antosubash
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@8aa4ac120ac7d9aaf8d92d1086e39b9dd3a7fdd1
- Trigger Event: workflow_dispatch