Skip to main content

Django Admin Keycloak

Project description

django-admin-keycloak

Tests

Keycloak

Create Client OpenID with callback url https://keycloak.example.ru/sso/* add client scopes "roles" and set client Backchannel logout URL https://keycloak.example.ru/sso/logout

Settings

# define static config or add provider later in admin management
KEYCLOAK_PROVIDERS = [
    {
        'slug': 'local', # internal django slug
        'name': 'Local', # name on login form
        'client_id': 'local_django',
        'client_secret': 'SECRET',
        'redirect_uri': '/admin', # redirect uri after login
        'server_url': 'https://keycloak.example.ru',
        'realm_name': 'django',
        'role_staff_user': 'dev_staff', # role for staff users
        'role_super_user': 'dev_super_user', # role for superusers
    }
]

Add to INSTALLED_APPS

INSTALLED_APPS = [
    'django_admin_keycloak',
    'django.contrib.admin',
    # ...
]

Add to urls.py

urlpatterns = [
    # ...,
    path('sso/', include('django_admin_keycloak.url')),
    # ...
]

If you define static config, you must execute command for update providers.

python manage.py update_static_providers

Available signals

user_sso_login

On login SSO user
  • session: KeycloakSession
  • request: HttpRequest
  • userinfo: dict
  • access_token: str

user_sso_logout

On logout SSO user
  • session: KeycloakSession
  • request: HttpRequest

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

django_admin_keycloak-1.0.3.tar.gz (66.4 kB view details)

Uploaded Source

Built Distribution

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

django_admin_keycloak-1.0.3-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

Details for the file django_admin_keycloak-1.0.3.tar.gz.

File metadata

  • Download URL: django_admin_keycloak-1.0.3.tar.gz
  • Upload date:
  • Size: 66.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for django_admin_keycloak-1.0.3.tar.gz
Algorithm Hash digest
SHA256 4dba4dc903c26408437cc74e43757cdbbc75f8e9353e9339668839984a19da95
MD5 106f145db0d7b8ff3328944933646ed5
BLAKE2b-256 52bdbe8c77b139c08d40bed72b3aaa7336ae1d4c4a4e7007f0759db9f47adf37

See more details on using hashes here.

File details

Details for the file django_admin_keycloak-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: django_admin_keycloak-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 32.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for django_admin_keycloak-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 12e8f963e7da3dd04716b96eb5b7c556e648d1db872a81cf6fe1aee638c751c2
MD5 5d566ea3ceb6e766026eff409a35a469
BLAKE2b-256 3b94d2ebe35dc6d0a7ae4472a4cec19d9c03d11602fce7e92937f11bce104501

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