IActivatableByAdmin.php 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Authentication\TwoFactorAuth;
  25. use OCP\IUser;
  26. /**
  27. * Marks a 2FA provider as activatable by the administrator. This means that an
  28. * admin can activate this provider without user interaction. The provider,
  29. * therefore, must not require any user-provided configuration.
  30. *
  31. * @since 15.0.0
  32. */
  33. interface IActivatableByAdmin extends IProvider {
  34. /**
  35. * Enable this provider for the given user.
  36. *
  37. * @param IUser $user the user to activate this provider for
  38. *
  39. * @return void
  40. *
  41. * @since 15.0.0
  42. */
  43. public function enableFor(IUser $user);
  44. }