====== oAuthGeneric Plugin ======

---- plugin ----
description: Generic Service for use with the oAuth Plugin
author     : Andreas Gohr 
email      : dokuwiki@cosmocode.de
type       : action
lastupdate : 2024-03-21
compatible : Hogfather
depends    : oauth
conflicts  : 
similar    : 
tags       : oauth, authentication

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-oauthgeneric/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-oauthgeneric/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-oauthgeneric/
donationurl: 

screenshot_img :
----

This plugin implements the a generic oAuth workflow that may or may not be able to communicate with an Identity Provider of your choice.

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

===== Installation =====

:!: **External requirements:** This plugin requires the [[plugin:oauth|oAuth Plugin]].

Install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Configuration =====

You need to set the Client ID and Secret of your Generic Authentication application. Additionally the apropriate endpoint URLs and scopes have to be configured.

It is expected that the userinfo endpoint returns user data as JSON. You need to map in what fields the needed users info can be found. To access deeper nested data, you can use dot notation.

==== Configuration Examples ====

Below is a list of examples on how to configure oAuth access to different service using the generic plugin.

  * [[~:iserv|IServ]]

===== Development =====

=== Change Log ===

{{rss>https://github.com/cosmocode/dokuwiki-plugin-oauthgeneric/commits/master.atom date}}