<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace KTXF\Resource\Provider;

use KTXF\Json\JsonSerializable;

/**
 * Resource Service Identity Interface
 * 
 * Base interface for authentication credentials used by resource services.
 * 
 * @since 2025.05.01
 */
interface ResourceServiceIdentityInterface extends JsonSerializable {

    public const TYPE_NONE = 'NA';
    public const TYPE_BASIC = 'BA';
    public const TYPE_TOKEN = 'TA';
    public const TYPE_OAUTH = 'OA';
    public const TYPE_CERTIFICATE = 'CC';

    /**
     * Gets the identity/authentication type
     * 
     * @since 2025.05.01
     * 
     * @return string One of: TYPE_NONE, TYPE_BASIC, TYPE_TOKEN, TYPE_OAUTH, TYPE_CERTIFICATE
     */
    public function type(): string;

}