0
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-03-04 20:14:50 +00:00
nextcloud_server/lib/public/Authentication/Token/IProvider.php
Andy Scherzinger dae7c159f7
chore: Add SPDX header
Signed-off-by: Andy Scherzinger <info@andy-scherzinger.de>
2024-05-24 13:11:22 +02:00

40 lines
955 B
PHP

<?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;
}