# 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/](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/](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
Step:
- python -m build
- python -m twine upload --repository pypi dist/*
Raw data
{
"_id": null,
"home_page": "https://github.com/cedvict/fastapi-keycloak-extended",
"name": "fastapi-keycloak-extended",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Cedvict Loknov <cedvict@gmail.com>",
"keywords": "Keycloak,FastAPI,Authentication,Authorization",
"author": "Cedvict Loknov",
"author_email": "Cedvict Loknov <cedvict@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/47/16/a078f84a70ad6c3c9437ea4401e820ea0a1e2ad24675a5aabd72270dbfa9/fastapi_keycloak_extended-1.0.10.1.tar.gz",
"platform": null,
"description": "# FastAPI Keycloak Integration\n\n---\n\n\nWelcome 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\nencouraged due to specific features. Currently, this package supports only the `password` and the `authorization_code`. However, the `get_current_user()` method accepts any JWT\nthat was signed using Keycloak\u00b4s private key.\n\n## Docs\n\nRefer to [https://fastapi-keycloak.code-specialist.com/](https://fastapi-keycloak.code-specialist.com/).\n\nAdding some features:\n - KeycloakToken with more datas (refresh token, expires_in, etc.)\n - KeycloakRefreshToken represents the response after refresh token\n - KeycloakGroup with field `attributes`\n - Function to retrieve groups by attribute\n - Update call api GET (for users and groups) with param briefRepresentation as false. This allows to get the full representation of the object.\n - Update create_user and create_group\n - Function to refresh token\n - Override user_login to take an account more details\n - Update OIDCUser to add field from attributes\n\nThis exposes all fastapi_keycloak features under fastapi_keycloak_extended.\n\n## Keycloak version\nModule tested with version of keycloak:\n- 16.0 (server uri must end with /auth )\n- 22.0\n\n## Build and publish\n\nRefer to [https://packaging.python.org/en/latest/tutorials/packaging-projects/](https://packaging.python.org/en/latest/tutorials/packaging-projects/)\n\nStep:\n- python -m build\n- python -m twine upload --repository pypi dist/*\n",
"bugtrack_url": null,
"license": "",
"summary": "FastAPI Keycloak Extended",
"version": "1.0.10.1",
"project_urls": {
"Documentation": "https://fastapi-keycloak.code-specialist.com/",
"Homepage": "https://github.com/cedvict/fastapi-keycloak-extended"
},
"split_keywords": [
"keycloak",
"fastapi",
"authentication",
"authorization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ebedf0a7dc778f233243b34f981adb4c7d88b663e2703af330413d0633938e59",
"md5": "93e774130f6b841c6cbdac487aae25aa",
"sha256": "fe0b448829b33629806dff40f3b0187a2bab110271d08530ce2643fb566d2743"
},
"downloads": -1,
"filename": "fastapi_keycloak_extended-1.0.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93e774130f6b841c6cbdac487aae25aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19781,
"upload_time": "2023-10-26T13:58:31",
"upload_time_iso_8601": "2023-10-26T13:58:31.101733Z",
"url": "https://files.pythonhosted.org/packages/eb/ed/f0a7dc778f233243b34f981adb4c7d88b663e2703af330413d0633938e59/fastapi_keycloak_extended-1.0.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4716a078f84a70ad6c3c9437ea4401e820ea0a1e2ad24675a5aabd72270dbfa9",
"md5": "f84c28a558fdd49818f0c061fd64a61d",
"sha256": "b47ff24c2c911522381f82c61bf53b3eaa33d33b1282550d1541933a5509c355"
},
"downloads": -1,
"filename": "fastapi_keycloak_extended-1.0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "f84c28a558fdd49818f0c061fd64a61d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 18309,
"upload_time": "2023-10-26T13:58:34",
"upload_time_iso_8601": "2023-10-26T13:58:34.072773Z",
"url": "https://files.pythonhosted.org/packages/47/16/a078f84a70ad6c3c9437ea4401e820ea0a1e2ad24675a5aabd72270dbfa9/fastapi_keycloak_extended-1.0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 13:58:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cedvict",
"github_project": "fastapi-keycloak-extended",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "fastapi-keycloak-extended"
}
JSON
