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

The web application for GraphDB APIs

import { HttpService } from '../http/http.service';
import { AuthenticatedUser, SecurityConfig } from '../../models/security';
/**
 * Service class for handling security-related REST operations.
 */
export declare class SecurityRestService extends HttpService {
    private readonly SECURITY_ENDPOINT;
    /**
     * Updates the application settings for a specific user.
     *
     * @param user - The authenticated user whose data needs to be updated.
     * @returns A Promise that resolves when the update is successful, or rejects if there's an error.
     */
    updateUserData(user: AuthenticatedUser): Promise<void>;
    /**
     * Retrieves the full security configuration from the backend.
     *
     * Sends a GET request to fetch the application's security-related configuration, including roles, permissions,
     * and OpenID settings.
     *
     * @returns A Promise that resolves with the SecurityConfig object.
     */
    getSecurityConfig(): Promise<SecurityConfig>;
    /**
     * Retrieves information about the currently authenticated user.
     *
     * Sends a GET request to the security endpoint to fetch details about the user
     * who is currently authenticated in the system.
     *
     * @returns A Promise that resolves with the AuthenticatedUser object containing
     *          the user's details such as username, roles, and application settings.
     */
    getAuthenticatedUser(): Promise<AuthenticatedUser>;
}