aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Authentication/Token/IProvider.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Authentication/Token/IProvider.php')
-rw-r--r--lib/public/Authentication/Token/IProvider.php40
1 files changed, 40 insertions, 0 deletions
diff --git a/lib/public/Authentication/Token/IProvider.php b/lib/public/Authentication/Token/IProvider.php
new file mode 100644
index 00000000000..ade44a3ee94
--- /dev/null
+++ b/lib/public/Authentication/Token/IProvider.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCP\Authentication\Token;
+
+use OCP\Authentication\Exceptions\ExpiredTokenException;
+use OCP\Authentication\Exceptions\InvalidTokenException;
+use OCP\Authentication\Exceptions\WipeTokenException;
+
+/**
+ * @since 24.0.8
+ */
+interface IProvider {
+ /**
+ * invalidates all tokens of a specific user
+ * if a client name is given only tokens of that client will be invalidated
+ *
+ * @param string $uid
+ * @param string|null $clientName
+ * @since 24.0.8
+ * @return void
+ */
+ public function invalidateTokensOfUser(string $uid, ?string $clientName);
+
+ /**
+ * Get a token by token string id
+ *
+ * @since 28.0.0
+ * @throws InvalidTokenException
+ * @throws ExpiredTokenException
+ * @throws WipeTokenException
+ * @return IToken
+ */
+ public function getToken(string $tokenId): IToken;
+}