Differences

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

--- en:plugins:impersonate [2026/09/15 10:23] – [Releases] reinhold
+++ en:plugins:impersonate [2026/10/05 00:07] (current) – Release 1.0.0 added reinhold
@@ Line 1: / Line 1: @@
-====== Impersonate ======
+====== Admidio Impersonate Plugin — act as another user ======
-Allows administrators to temporarily act as another Admidio user in order
+==== Description ====
-to reproduce permission and configuration problems.
+A third-party plugin for Admidio 6.0 and later that lets an administrator act as another user, to make
+changes on behalf of them or to find out why
+something does not work for them. For the duration, Admidio behaves exactly as if that user had logged
+in: the same menu, the same rights, the same lists and profile fields.
-The plugin integrates with Admidio's plugin system introduced for Admidio
+==== Downloads ====
-.1.
+<WRAP download 60%>
+{{admidioplugins>releases}}
+</WRAP>
-===== Plugin information =====
-The structured metadata for this page is maintained using the
+==== Screenshot ====
-''admidio_plugin'' Struct schema.
+{{:en:plugins:impersonate:06-impersonate-plugin-impersonating-design.png?300|}}
-===== Releases =====
----- struct serial ----
+==== Installation ====
-schema: admidio_plugin_release
-cols: version, release_date, admidio_min, admidio_max, php_min, download, featured, release_status, notes
-----
-===== Installation =====
+As administrator, go to Admidio's plugin manager (Admidio 5.1 or later required!), select "Add plugin" and upload the plugin zip file ''impersonate-1.0.0.zip''.
+{{:en:plugins:impersonate:00b-impersonate-install.png?400|Uploading the plugin file in the plugin manager}}
+{{:en:plugins:impersonate:00a-impersonate-install.png?600|Add plugin button in the plugin manager}}
+{{:en:plugins:impersonate:01-impersonate-plugin-manager.png?600|Enabling the plugin}}
-Install the ZIP archive through:
+==== How to impersonate====
-  Administration → Plugin Manager → Add plugin
+Once the plugin is installed and enabled in Admidio's plugin manager,
+the contacts list shows little "impersonate" icons for each user.
-Admidio 5.1 or newer is required.
+{{:en:plugins:impersonate:04-impersonate-plugin-userlist.png?600|Impersonate icons in the contacts list}}
-===== Usage =====
+{{:en:plugins:impersonate:05-impersonate-plugin-userlist-ask.png?400|Impersonate a user}}
-After activation, administrators get an impersonation action for users
+Clicking on it makes the administrator assume the
-they are permitted to impersonate.
+identity of the corresponding user.
+{{:en:plugins:impersonate:06-impersonate-plugin-impersonating-design.png?600|Impersonate a user}}
+While impersonating another user, the design of the Admidio installation changes clearly
+to keep the administrator reminded. After a certain, configurable time, the impersonation
+is automatically ended and the session returns to the administrator user. Manual logout
+before the timeout also ends the impersonation.
+{{:en:plugins:impersonate:07-impersonate-plugin-end.png?600|Ending an impersonation}}
+==== What it does ====
+  * **Contacts list:** administrators get an *Act as …* icon in every row of a user they may act as. After a confirmation the session belongs to that user.
+  * **Visible on every page:** while acting as a user, the header bar is striped, the sidebar is tinted, and a banner names the user, the administrator and the time at which the session returns automatically. The banner has a *Return to my account* button.
+  * **Logout returns:** logging out while acting as a user returns the administrator to their own account instead of ending the session. A second logout logs out normally.
+  * **Change history:** every change made while acting as a user is stored with a comment *Impersonated by Firstname Lastname (username)*. The change history shows an asterisk after the row number of such a change, with the comment as its tooltip.
+  * **Profile change notifications** name the administrator: *… was changed by Anna Muster (login: anna) [impersonated by Max Admin (max)]*.
+  * **History:** every impersonation is recorded with the administrator, the user, the start, the end, how it ended and the IP address. The preferences panel links to the history page.
+{{:en:plugins:impersonate:03-impersonate-plugin-history.png?600|Impersonate history}}
+==== What is refused while acting as a user ====
+  * **Single sign-on** (`modules/sso/index.php`): no other application may be logged in with the identity of the user.
+  * **Sending messages, emails and e-cards** (`messages_send.php`, `ecard_send.php`): nothing goes out in the name of the user. Reading messages and opening the message form stay possible.
+Everything else is allowed, including changing the password, the email address or deleting the
+account — an administrator can do all of that without acting as the user as well.
+==== Settings ====
+**Administration → Preferences → Login & security → Impersonate**
+{{:en:plugins:impersonate:02-impersonate-plugin-settings.png?600|Plugin settings}}
+^ Setting ^ Default ^ Meaning ^
+| Administrators who may act as other users | All administrators | Only administrators can ever act as other users. Selecting roles restricts it to administrators who are members of at least one of them. |
+| Only users with fewer rights | on | An administrator can only act as a user whose roles they share or administer. This stops an administrator of one organization from acting as a user with rights in another organization. |
+| Time limit in minutes | 30 | Counted from the start. When it has passed, the administrator is returned to their own account. |
+| Notify the user | off | Sends the user an email when an administrator starts acting as them. |
+==== Limits ====
+  * The impersonation belongs to the PHP session, so every browser tab of the session acts as the user.
+  * An impersonation that is never ended — the browser is closed — is shown in the history as not ended once its time limit has passed.
+  * Disabling the plugin in the middle of an impersonation leaves the session with the user until it expires or is logged out; single sign-on stays unavailable to it.
+  * System emails other than the profile change notification (event registrations, for example) are sent as they would be for the user.
+==== History ====
+//1.0.0 (12.09.2026)//
+  * Initial release for the new plugin system of Admidio 6.0
-===== Links =====
-  * [[https://github.com/kainhofer/admidio-impersonate|Source repository]]
 ---- struct data ----
+admidio_plugin.plugin_id : impersonate
+admidio_plugin.name  : Impersonate
+admidio_plugin.description : A third-party plugin for Admidio 6.0 and later that lets an administrator act as another user, to make changes on behalf of them or to find out why something does not work for them. For the duration, Admidio behaves exactly as if that user had logged in: the same menu, the same rights, the same lists and profile fields.
+admidio_plugin.description_de : Ein Drittanbieter-Plugin für Admidio 6.0 und neuer, mit dem ein Administrator als ein anderer Benutzer agieren kann, um Änderungen in dessen Namen vorzunehmen oder herauszufinden, warum etwas für diesen Benutzer nicht funktioniert. Für die Dauer der Benutzerübernahme verhält sich Admidio genauso, als hätte sich dieser Benutzer selbst angemeldet: dasselbe Menü, dieselben Rechte, dieselben Listen und Profilfelder.
+admidio_plugin.author : Reinhold Kainhofer
+admidio_plugin.maintainer :
+admidio_plugin.author_url : https://open-tools.net/
+admidio_plugin.homepage : https://www.admidio.org/dokuwiki/doku.php?id=en:plugins:impersonate
+admidio_plugin.repository : https://github.com/kainhofer/admidio-impersonate
+admidio_plugin.license : GPL 2
+admidio_plugin.icon  :
+admidio_plugin.category : Administration
+admidio_plugin.plugin_status : active
+admidio_plugin.supported_databases : MySQL, MariaDB, PostgreSQL
+admidio_plugin.supported_translations : de, de-DE, en
+admidio_plugin.tags  : user, administration
 ----