@umbraco/headless-client/Clients/AuthenticationClient.d.ts

Node.js client library for the Umbraco Headless APIs

import { Client } from '../Client';
import { OAUthResponse } from '../Responses';
/**
 * AuthenticationClient is used to authenticate members and Backoffice users.
 * @public
 *
 * @example
 * The {@link AuthenticationClient} must be accessed through {@link Client}.
 *
 * ```typescript
 * import { Client } from '@umbraco/headless-client'
 *
 * const client = new Client({
 *  projectAlias: '<your-project-alias>',
 *  apiKey: '<your-api-key>',
 *  language: '<iso-code>',
 * })
 *
 * const authClient = client.authentication
 * ```
 */
export declare class AuthenticationClient {
    private readonly client;
    /**
     * @internal
     */
    constructor(client: Client);
    /**
     * Authenticate a member using username and password.
     * @param username - The members username.
     * @param password - The members password.
     * @returns a Promise resolving to a {@link OAUthResponse}
     */
    authenticateMember(username: string, password: string): Promise<OAUthResponse>;
    /**
     * Authenticate a Backoffice user using username and password.
     * @param username - The users username.
     * @param password - The users password.
     * @returns a Promise resolving to a {@link OAUthResponse}
     */
    authenticateUser(username: string, password: string): Promise<OAUthResponse>;
}