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

OAuth2 OpenId Connect Documentation #201

Merged
merged 8 commits into from
Dec 12, 2022
Merged

Conversation

davidblasby
Copy link
Contributor

@davidblasby davidblasby commented Aug 9, 2022

This is a sibling commit for geonetwork/core-geonetwork#6494.

This is the documentation for the added features.

#. `OPENIDCONNECT_CLIENTSECRET=...` (from your IDP server)
#. `OPENIDCONNECT_CLIENTID=...` (from your IDP server)
#. `OPENIDCONNECT_SERVERMETADATA_JSON_TEXT='...'` (the text of your Server's JSON metadata document)
#. `OPENIDCONNECT_IDTOKENROLELOCATION=...` (location of the user's roles in the ID Token)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better to format this block using .. code-block:: properties?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's best this way - there's commentary with the configuration and this formatting makes it more obvious.

@juanluisrp
Copy link
Contributor

@davidblasby is this documentation ready?

@davidblasby
Copy link
Contributor Author

@juanluisrp - yes, the core-geonetwork code has been merged. Please merge this.
thanks!

@josegar74 josegar74 merged commit 1d7c733 into geonetwork:develop Dec 12, 2022
josegar74 pushed a commit that referenced this pull request Dec 12, 2022
* wip: openid connect dox

* for OPENIDCONNECT_ROLECONVERTER, changed format from ':' to '=' as separator

* add doc for oidc bearer tokens

* feedback from jose

* add doc for OPENIDCONNECT_LOGINTYPE

* add info about OPENIDCONNECT_SERVERMETADATA_CONFIG_URL

* update doc for default scopes

* add doc for OPENIDCONNECT_LOGSENSITIVE_INFO

Co-authored-by: david.blasby <david.blasby@geocat.net>
josegar74 added a commit that referenced this pull request Dec 12, 2022
josegar74 added a commit that referenced this pull request Dec 12, 2022
josegar74 added a commit that referenced this pull request Mar 7, 2023
* Update user profile privileges descriptions (#195)

* Changelog for 3.12.4

* Changelog for 3.12.5

* Changelog for 3.12.6

* Fix typos

* Change log for 3.12.7 (#211)

* Update index.rst

Fixed typo there->their

* Add missing space 

Fix #215.

* Fix not visible code block

* Fix example for creating an HTML-based static page

The example had `format=LINK`, which posting html as form data. This will result in a bad request.

* fix environment variable name 

geonetwork.security.type instead of config.security.type

* INSPIRE / Some template fixes

* Added baisic OAI-PMH endpoint description

* OAuth2 OpenId Connect Documentation (#201)

* wip: openid connect dox

* for OPENIDCONNECT_ROLECONVERTER, changed format from ':' to '=' as separator

* add doc for oidc bearer tokens

* feedback from jose

* add doc for OPENIDCONNECT_LOGINTYPE

* add info about OPENIDCONNECT_SERVERMETADATA_CONFIG_URL

* update doc for default scopes

* add doc for OPENIDCONNECT_LOGSENSITIVE_INFO

Co-authored-by: david.blasby <david.blasby@geocat.net>

* wrong line number

* Revert "OAuth2 OpenId Connect Documentation (#201)" (#220)

This reverts commit 1d7c733.

* Change log for 3.12.8

* Update GeoNetwork branch name

* Add example of connecting to the API with python

This change is to add a simple example of how to authenticate to the API and obtain the XRSF token with python.

* Update authors.rst

* 4.2.3 changelog.

* Update release instructions.

* Change log for 3.12.9

* Update indentation in 3.12.9 changelog

---------

Co-authored-by: Jose García <josegar74@gmail.com>
Co-authored-by: seblessware1spatial <100566189+seblessware1spatial@users.noreply.github.com>
Co-authored-by: Juan Luis Rodríguez Ponce <juanluisrp@gmail.com>
Co-authored-by: Mike Bryant <mikesname@gmail.com>
Co-authored-by: Tristan <tristanp93@gmail.com>
Co-authored-by: giulioverazzo <giulio.verazzo@gmail.com>
Co-authored-by: davidblasby <48937730+davidblasby@users.noreply.github.com>
Co-authored-by: david.blasby <david.blasby@geocat.net>
Co-authored-by: axel584 <axel584@gmail.com>
Co-authored-by: Alex <119129964+geoawd@users.noreply.github.com>
Co-authored-by: Jeroen Ticheler <Jeroen.Ticheler@GeoCat.net>
Co-authored-by: Florent Gravin <florent.gravin@camptocamp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants