aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Authentication/TwoFactorAuth/IDeactivatableByAdmin.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Authentication/TwoFactorAuth/IDeactivatableByAdmin.php')
-rw-r--r--lib/public/Authentication/TwoFactorAuth/IDeactivatableByAdmin.php31
1 files changed, 31 insertions, 0 deletions
diff --git a/lib/public/Authentication/TwoFactorAuth/IDeactivatableByAdmin.php b/lib/public/Authentication/TwoFactorAuth/IDeactivatableByAdmin.php
new file mode 100644
index 00000000000..e6cf91ac6a3
--- /dev/null
+++ b/lib/public/Authentication/TwoFactorAuth/IDeactivatableByAdmin.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Authentication\TwoFactorAuth;
+
+use OCP\IUser;
+
+/**
+ * Marks a 2FA provider as activale by the administrator. This means that an
+ * admin can activate this provider without user interaction. The provider,
+ * therefore, must not require any user-provided configuration.
+ *
+ * @since 15.0.0
+ */
+interface IDeactivatableByAdmin extends IProvider {
+ /**
+ * Disable this provider for the given user.
+ *
+ * @param IUser $user the user to deactivate this provider for
+ *
+ * @return void
+ *
+ * @since 15.0.0
+ */
+ public function disableFor(IUser $user);
+}