Skip to content

Commit

Permalink
Merge pull request #31 from collective/maurits-readme-scope-openid
Browse files Browse the repository at this point in the history
Readme: suggest openid and profile as scopes for Keycloak.
  • Loading branch information
mauritsvanrees authored Nov 2, 2023
2 parents 7efd0ea + d2aab30 commit 93b5c4b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -234,13 +234,19 @@ Setup Plone as a client

* ``Use deprecated redirect_uri for logout url(/Plone/acl_users/oidc/logout)`` checked. Use this if you need to run old versions of Keycloak.

**Tip:** Leave the rest at the defaults, unless you know what you are doing.
* ``Open ID scopes to request to the server``: this 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``.

* **Tip:** Leave the rest at the defaults, unless you know what you are doing.

* Click ``Save``.

**Plone is ready done configured!**

[TODO] screenshot.
See this screenshot:

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

*Warning:*

Expand Down Expand Up @@ -358,4 +364,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 93b5c4b

Please sign in to comment.