Skip to content

Commit

Permalink
Readme: suggest openid and profile as scopes for Keycloak.
Browse files Browse the repository at this point in the history
A test setup at a client no longer worked after they updated the Keycloak version (not sure which one exactly), and this fixed it.

Added screenshot of settings, which was marked as a TODO item.
Fixed check-manifest.
  • Loading branch information
mauritsvanrees committed Oct 23, 2023
1 parent b42a4c1 commit 9267f4e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,14 @@ Setup Plone as client
* OIDC/Oauth2 Issuer: http://localhost:8080/realms/plone/
* client ID: plone. This must match the client ID you have set in Keycloak.
* Use deprecated redirect_uri. Use this if you need to run old versions of keycloak.
* For the scopes it depends on which version of Keycloak you are using, and which scopes are available there.
In recent Keycloak versions, you *must* include ``openid`` as scope.
Suggestion is to use ``openid`` and ``profile``.
* Leave the rest at the default and save the changes.

[TODO] screenshot.
See this screenshot:

.. image:: docs/screenshot-settings.png

Attention, before keycloak 18, the parameter for logout was redirect_uri and it is deprecated since version 18. But the keycloak server can run with the redirect_uri if needed, it is possible to use the plugin with the legacy parameter enabled also. The problem is that if the deprecated parameter is enabled in the plugin but not in the server, the plugin will not work.

Expand Down Expand Up @@ -259,4 +264,4 @@ The project is licensed under the GPLv2.

.. _`collective.regenv`: https://pypi.org/project/collective.regenv/
.. _`Products.mcdutils`: https://pypi.org/project/Products.mcdutils/
.. _PKCE: https://datatracker.ietf.org/doc/html/rfc7636
.. _PKCE: https://datatracker.ietf.org/doc/html/rfc7636
Binary file added docs/screenshot-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
[check-manifest]
ignore =
*.cfg
*.txt
.coveragerc
.editorconfig
.gitattributes
.gitlab-ci.yml
tox.ini

[isort]
# black compatible isort rules:
Expand Down

0 comments on commit 9267f4e

Please sign in to comment.