Allow user backends to specify a custom logout url

* Allows SSO backends to do a global logout

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>

1 files changed, 43 insertions, 0 deletions

diff --git a/lib/public/User/Backend/ICustomLogout.php b/lib/public/User/Backend/ICustomLogout.php
new file mode 100644
index 00000000000..a6210a24647
--- /dev/null
+++ b/lib/public/User/Backend/ICustomLogout.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2020, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\User\Backend;
+
+/**
+ * @since 20.0.0
+ *
+ * Allow backends to signal that they handle logout. For example
+ * SSO providers that also have a SSO logout url
+ */
+interface ICustomLogout {
+	/**
+	 * @since 20.0.0
+	 *
+	 * The url to redirect to for logout
+	 *
+	 * @return string
+	 */
+	public function getLogoutUrl(): string;
+}