@dasch-swiss/dsp-js/src/api/v2/authentication/authentication-endpoint-v2.d.ts

TypeScript client library for DSP-API

import { ApiResponseData } from '../../../models/api-response-data';
import { Endpoint } from '../../endpoint';
/**
 * Handles requests to the authentication route of the Knora API.
 *
 * @category Endpoint V2
 */
export declare class AuthenticationEndpointV2 extends Endpoint {
    /**
     *  Logs in a user.
     *
     * @param property The name of the property by which the user is identified.
     * @param id the given user.
     * @param password the user's password.
     */
    login(property: 'iri' | 'email' | 'username', id: string, password: string): import("rxjs").Observable<ApiResponseData<any>>;
    /**
     *  Logs out the user and destroys the session on the server- and client-side.
     */
    logout(): import("rxjs").Observable<ApiResponseData<any>>;
    /**
     * Checks credentials.
     *
     * Returns a `ApiResponseError` if the client is not authorized.
     */
    checkCredentials(): import("rxjs").Observable<ApiResponseData<any>>;
}
//# sourceMappingURL=authentication-endpoint-v2.d.ts.map