search

code-specialist / fastapi-keycloak

Keycloak integration for Python FastAPI
https://fastapi-keycloak.code-specialist.com/
Apache License 2.0
195 stars 52 forks source link

User Logout #42

Open kaustuv-zb opened 2 years ago

kaustuv-zb commented 2 years ago

Hi,

Cheers to the commendable work that you have done.

Can you shed some light on the "user logout" as well, I do not see a method for that.

Though the token expires after some time from KeyCloak but a user logout would be great.

Also, can you shed some light on maybe your documentation about how the [admin-cli] and [auth-flow] endpoints are supposed to work so that your docs become more powerful and user-friendly.

Looking forward to hear from you.

Cheers, Kaustuv.

yannicschroeer commented 2 years ago

Hi @kaustuv-zb,

Indeed we do not have any support for logouts yet.

Regarding the explicitness of our docs; could you please provide specific information on what you're missing here? I agree that it could definitely use some improvement, but I don't want to unnecessarily prolong the docs as well.

In general, we do not have the capacity to actively develop this library at the moment, but pull requests are always welcome and reviewed conscientiously :)

kaustuv-zb commented 2 years ago

Hi @yannicschroeer,

Thank you for getting back on this.

I require 2 things right now:

  1. How to use the APIs with the tags -> [admin-cli] and [auth-flow].
  2. User logout.

Once that it added, your docs and APIs can be much better than what it is now.

Best regards.

JonasScholl commented 2 years ago

Hi @kaustuv-zb,

the API endpoints with the tags admin-cli and auth-flow are basically proxies for some common requests to Keycloak. The purpose of them is to have a unique interface so that users of the API don't have to call Keycloak directly, they should be able to only interact with the API. Since the names of those endpoints mirror exactly the endpoints / functionalities from Keycloak there is not always an explicit documentation for this, it wouldn't add more information (however, PRs always welcome for this :D). fastapi-keycloak is not an own auth solution and just provides some functionality for integrating Keycloak in FastAPI, so if you want to know how to use the endpoints you can find a more detailed explanation for most of the endpoints in the Keycloak documentation.

Regarding the user logout: As @yannicschroeer already mentioned, we are always open and thankful for any contributions / pull requests since we maintain this project only by the way and don't have time for implementing every new feature. Additionally I just wanted to mention that already issued tokens are still valid after the logout, it just terminates the session on the side of Keycloak 😄

Best regards.