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)
2.1k Dec 31, 2022
95 Jan 08, 2023
2.8k Jan 04, 2023
33 Nov 28, 2022
7 Oct 01, 2021
9 Jan 02, 2023
7 Aug 01, 2022
1 Nov 28, 2021
4 Dec 05, 2022
1 Dec 15, 2021
2 Mar 04, 2022
31 Nov 30, 2022
683 Jan 03, 2023
1.3k Dec 31, 2022
4 Mar 25, 2022
0 Sep 24, 2022
2 Aug 15, 2022
5 Jan 07, 2023
13 Mar 24, 2022
12 Jul 15, 2022