Skip to content

Commit aa37ad2

Browse files
susnuxkesselb
authored andcommitted
fix: adjust two factor documentation
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
1 parent f9e34b9 commit aa37ad2

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

admin_manual/configuration_user/two_factor-auth.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Two-factor authentication
55
=========================
66

77
Two-factor authentication adds an additional layer of security to user accounts. In order to log
8-
in on an account when two-factor authentication (2FA) enabled, it is necessary to provide both the
8+
in on an account when two-factor authentication (2FA) enabled, you must provide both the
99
login password and another factor.
1010

1111
To use 2FA two things must happen:
@@ -76,21 +76,29 @@ a user has 2FA enforced:
7676
Provider removal
7777
----------------
7878

79-
Nextcloud keeps records about the enabled two-factor authentication providers of every user. If a provider is simply removed/:ref:`disabled <apps_commands_label>`, Nextcloud will still consider the provider active for the user at login and show a warning like *Could not load at least one of your enabled two-factor auth methods*.
79+
Nextcloud keeps records about the enabled two-factor authentication providers of every user.
80+
If a provider is simply removed/:ref:`disabled <apps_commands_label>`,
81+
Nextcloud will still consider the provider active for the user at login and show a warning like *Could not load at least one of your enabled two-factor auth methods*.
8082

8183
The associations of removed providers can be cleaned up via :ref:`occ <occ>`::
8284

83-
sudo -u www-data php occ twofactorauth:cleanup <provider_id>
85+
sudo -E -u www-data php occ twofactorauth:cleanup <provider_id>
86+
87+
.. warning:: This operation is irreversible. Only run it for providers you do not intend to enable again as then you have to setup the configuration for all users from scratch.
8488

85-
.. warning:: This operation is irreversible. Only run it for providers you do not intend to enable again.
8689

8790
Disabling two-factor authentication
8891
-----------------------------------
8992

9093
Two-factor providers can be disabled via :ref:`occ <occ>`::
9194

92-
sudo -u www-data php occ twofactorauth:disable <uid> <provider_id>
95+
sudo -E -u www-data php occ twofactorauth:disable <uid> <provider_id>
9396

94-
User are free to enable this provider again via their personal settings.
97+
This can be useful if the user forgot or lost their second factor.
98+
Afterwards users are free to enable this provider again via their personal settings.
9599

96100
.. note:: This operation has to be supported by the provider. If this support is missing, Nextcloud will abort and show an error.
101+
102+
It is also possible to check the current two-factor user status via :ref:`occ <occ>`::
103+
104+
sudo -E -u www-data php occ twofactorauth:state <uid>

0 commit comments

Comments
 (0)