Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.5 KB

README.md

File metadata and controls

38 lines (27 loc) · 1.5 KB
Raw

FastAPI Keycloak Integration

Welcome to fastapi-keycloak. This projects goal is to ease the integration of Keycloak (OpenID Connect) with Python, especially FastAPI. FastAPI is not necessary but is encouraged due to specific features. Currently, this package supports only the password and the authorization_code. However, the get_current_user() method accepts any JWT that was signed using Keycloak´s private key.

Docs

Refer to https://fastapi-keycloak.code-specialist.com/.

Adding some features:

  • KeycloakToken with more datas (refresh token, expires_in, etc.)
  • KeycloakRefreshToken represents the response after refresh token
  • KeycloakGroup with field attributes
  • Function to retrieve groups by attribute
  • Update call api GET (for users and groups) with param briefRepresentation as false. This allows to get the full representation of the object.
  • Update create_user and create_group
  • Function to refresh token
  • Override user_login to take an account more details
  • Update OIDCUser to add field from attributes

This exposes all fastapi_keycloak features under fastapi_keycloak_extended.

Keycloak version

Module tested with version of keycloak:

  • 16.0 (server uri must end with /auth )
  • 22.0

Build and publish

Refer to https://packaging.python.org/en/latest/tutorials/packaging-projects/

Step:

  • python -m build
  • python -m twine upload --repository pypi dist/*