Differences

This shows you the differences between two versions of the page.

--- devel:auth_plugins [2023-09-19 10:43] – [createUser] andi
+++ devel:auth_plugins [2025-11-07 13:11] (current) – More meaningful headline michaelsy
@@ Line 1: / Line 1: @@
-====== Authentication Plugins ======
+====== How to Write an Authentication Plugin ======
 DokuWiki's authentication system is highly modular and can, generally speaking, authenticate using anything that is accessible from PHP. Check the [[plugintype>128#extension__table|list of Auth Plugins]] to see what is already available. Auth Plugins can be installed via the [[plugin:Extension|Extension Manager]].
@@ Line 197: / Line 197: @@
 ==== modifyUser ====
-optional, set FIXME capability
+optional, set ''modLogin'', ''modPass'', ''modName'', ''modMail'', ''modGroups'' capabilities
 The [[xref>AuthPlugin::modifyUser()|modifyUser()]] method modifies a user's data. You can expect to only receive data as per set capabilities.
@@ Line 203: / Line 203: @@
 ==== deleteUsers ====
-optional, set FIXME capability
+optional, set ''delUser'' capability
 The [[xref>AuthPlugin::deleteUsers()|deleteUsers()]] method deletes one or more users.
@@ Line 209: / Line 209: @@
 ==== addGroup ====
-optional, set FIXME capability
+optional
-The [[xref>AuthPlugin::addGroup()|addGroup()]] method creates a new group.
+The [[xref>AuthPlugin::addGroup()|addGroup()]] method creates a new group. This only needs to be implemented if a group needs to be created before users can be assigned to it.
@@ Line 218: / Line 218: @@
 ==== logOff ====
-optional, set FIXME capability
+optional, set ''logout'' capability
 The [[xref>AuthPlugin::logOff|logOff()]] method is run in addition to the usual logoff. It is useful with [[#trustExternal|trustExternal()]] to initiate actions for the external backend e.g. use it to clear cookies or similar actions.