graphdb-workbench/dist/api/models/security/authentication/auth-strategy.d.ts

The web application for GraphDB APIs

import { AuthStrategyType } from './auth-strategy-type';
import { AuthenticatedUser } from '../authenticated-user';
/**
 * Interface for authentication strategies.
 *
 * Each authentication strategy implements this interface to provide a self-contained mechanism for authentication.
 * This design allows the security module to remain flexible and extensible, avoiding entangled logic.
 */
export interface AuthStrategy {
    /**
     * The type of authentication strategy.
     */
    type: AuthStrategyType;
    /**
     * Initializes the authentication strategy.
     * Can be used to perform setup tasks such as loading configuration or establishing connections.
     * @returns A promise that resolves to true if user is already logged in, false otherwise.
     */
    initialize(): Promise<boolean>;
    /**
     * Fetches the currently authenticated user. Different strategies may have different ways of retrieving this information.
     * @returns A promise that resolves to the authenticated user.
     */
    fetchAuthenticatedUser(): Promise<AuthenticatedUser>;
    /**
     * Authenticates a user with the provided login data.
     * @param loginData - The data required for authentication (varies by strategy).
     * @returns A promise that resolves to the authenticated user.
     */
    login(loginData: unknown): Promise<AuthenticatedUser>;
    /**
     * Logs out the currently authenticated user.
     * @returns A promise that resolves when logout is complete.
     */
    logout(): Promise<void>;
    /**
     * Checks if a user is currently authenticated.
     * @returns True if a user is authenticated, false otherwise.
     */
    isAuthenticated(): boolean;
    /**
     * Checks if the authenticated user is external
     */
    isExternal(): boolean;
}