FastAPI Keycloak Integration
Introduction
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 flow. However, the get_current_user() method accepts any JWT that was signed using Keycloak's private key.
!!! Caution This package is currently under development and is not yet officially released. However, you may still use it and contribute to it.
TLDR;
FastAPI Keycloak enables you to do the following things without writing a single line of additional code:
- Verify identities and roles of users with Keycloak
- Get a list of available identity providers
- Create/read/delete users
- Create/read/delete roles
- Assign/remove roles from users
- Implement the password flow (login/callback/logout)
Example
This example assumes you use a frontend technology (such as React, Vue, or whatever suits you) to render your pages and merely depicts a protected backend
app.py
import uvicorn
from fastapi import FastAPI, Depends
from fastapi_keycloak import FastAPIKeycloak, OIDCUser
app = FastAPI()
idp = FastAPIKeycloak(
app=app,
server_url="https://auth.some-domain.com/auth",
client_id="some-client",
client_secret="some-client-secret",
admin_client_secret="admin-cli-secret",
realm="some-realm-name",
callback_uri="http://localhost:8081/callback"
)
@app.get("/premium", tags=["secured-endpoint"])
def premium(user: OIDCUser = Depends(idp.get_current_user(required_roles=["premium"]))):
return f'Hi premium user {user}'
@app.get("/user/roles", tags=["secured-endpoint"])
def user_roles(user: OIDCUser = Depends(idp.get_current_user)):
return f'{user.roles}'
if __name__ == '__main__':
uvicorn.run('app:app', host="127.0.0.1", port=8081)
19 Dec 12, 2022
12 Jan 07, 2023
4 Jan 28, 2021
27 Oct 06, 2022
3 Mar 03, 2022
14 Jan 06, 2022
37 Dec 22, 2022
358 Nov 28, 2022
268 Jan 01, 2023
58 Dec 29, 2022
2 Aug 15, 2022
3 Apr 08, 2022
588 Jan 04, 2023
48 Mar 07, 2022
30 Sep 19, 2022
225 Jan 05, 2023
74 Dec 30, 2022
9 Jan 02, 2023
4 Apr 11, 2022