apim-developer-portal2/src/authentication/IAuthenticator.ts

API management developer portal

import { AccessToken } from "./accessToken";
import { HttpHeader } from "@paperbits/common/http/httpHeader";

export interface IAuthenticator {
    /**
     * Returns access token for current session.
     */
    getAccessToken(): Promise<string>;

    /**
     * Sets new token for the session.
     * @param accessToken {string} Access token in SharedAccessSignature or Bearer token format.
     */
    setAccessToken(accessToken: AccessToken): Promise<void>;

    /**
     * Sets new token for the session from response header and return refreshed value
     * @param responseHeaders {HttpHeader[]} Response headers.
     */
    refreshAccessTokenFromHeader(responseHeaders: HttpHeader[]): Promise<string>;

    /**
     * Clears access token from current session.
     */
    clearAccessToken(cleanOnlyClient?: boolean): void;

    /**
     * Checks if current user is signed in.
     */
    isAuthenticated(): Promise<boolean>;
}