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

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_module_keycloak-0.0.26.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.26.tar.gz
Algorithm Hash digest
SHA256 c711ab19039265d94b511258794195b2d463fe133f4ef94cd71dee4f4ee91de1
MD5 c6f984e8371a0e5b866c0cd990483fa2
BLAKE2b-256 b17f3062402bdea9e136b7308c0f2254530a9c1d4550735f2d66df6283333677

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_keycloak-0.0.26-py3-none-any.whl
Algorithm Hash digest
SHA256 ce0fc703c3b2ebdeec1de1cfcb7a1b84563a9bc769ec0c56e6238f4ff2b9edd7
MD5 dc0f362b324eea16d97bbd8f9dd94e1f
BLAKE2b-256 4438b857a3d863705b888e77124af7afc787d40f9185c60e1a744bb5aa6777ee

See more details on using hashes here.

Provenance

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

0.0.27

2 files

This release

0.0.26 This release

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