graphdb-workbench/dist/api/services/security/security.service.d.ts

The web application for GraphDB APIs

import { Service } from '../../providers/service/service';
import { AuthenticatedUser, SecurityConfig } from '../../models/security';
import { AuthSettings } from '../../models/security/auth-settings';
import { User } from '../../models/users/user';
import { HttpResponse } from '../../models/http';
import { AuthenticatedUserResponse } from '../../models/security/response-models/authenticated-user-response';
/**
 * Service class for handling security-related operations.
 */
export declare class SecurityService implements Service {
    private readonly securityRestService;
    private readonly securityContextService;
    private readonly usersService;
    /**
     * Updates the data of the authenticated user.
     *
     * Updates the authenticated user's data in the backend using the provided {@link User}
     *
     * @param user - The User object containing the updated data.
     * @returns A Promise that resolves when the user data has been successfully updated.
     */
    updateAuthenticatedUser(user: User): Promise<void>;
    /**
     * Retrieves the current security configuration from the backend.
     *
     * Fetches the security configuration and maps it to a `SecurityConfig` model using the appropriate mapper.
     *
     * @returns A Promise that resolves with the mapped `SecurityConfig` instance.
     */
    getSecurityConfig(): Promise<SecurityConfig>;
    /**
     * Retrieves the free access settings from the backend.
     *
     * Fetches the free access settings and maps it to an `AuthSettings` model using the appropriate mapper.
     *
     * @returns A Promise that resolves with the mapped `AuthSettings` instance.
     */
    getFreeAccess(): Promise<AuthSettings>;
    /**
     * Sets the free access configuration in the backend.
     *
     * Sends the updated free access settings to the backend and updates the security configuration
     * in the context with the latest data.
     *
     * @param enabled - A boolean indicating whether free access is enabled.
     * @param freeAccess - An optional `AuthSettings` object containing additional free access settings.
     * @returns A Promise that resolves when the free access settings have been successfully updated.
     */
    setFreeAccess(enabled: boolean, freeAccess?: AuthSettings): Promise<void>;
    /**
     * Retrieves the currently authenticated user from the backend.
     *
     * Fetches the authenticated user's information and maps it to an `AuthenticatedUser` model
     * using the appropriate mapper.
     *
     * @returns A Promise that resolves with the mapped `AuthenticatedUser` instance
     */
    getAuthenticatedUser(): Promise<AuthenticatedUser>;
    /**
     * Retrieves the admin user from the backend.
     *
     * Fetches the admin user's information and maps it to an `AuthenticatedUser` model
     * using the appropriate mapper.
     *
     * @returns A Promise that resolves with the mapped `AuthenticatedUser` instance representing the admin user.
     */
    getAuthenticatedAdminUser(): Promise<AuthenticatedUser>;
    /**
     * Checks if password-based login is enabled in the current security configuration.
     *
     * @returns `true` if password login is enabled; `undefined` if no config is present.
     */
    isPasswordLoginEnabled(): boolean;
    /**
     * Checks if OpenID login is enabled in the current security configuration.
     *
     * @returns `true` if OpenID is enabled; `undefined` if no config is present.
     */
    isOpenIDEnabled(): boolean;
    /**
     * Authenticates the user with username and password.
     *
     * Stores the auth token (if returned), updates the security context
     * with the mapped user, and returns the authenticated user model.
     *
     * @param username - The username of the user.
     * @param password - The password of the user.
     * @returns A Promise that resolves to the authenticated `AuthenticatedUser` model.
     */
    loginGdbToken(username: string, password: string): Promise<HttpResponse<AuthenticatedUserResponse>>;
}