Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme: suggest openid and profile as scopes for Keycloak. #31

Merged
merged 2 commits into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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