@zowe/imperative/lib/imperative/src/auth/doc/IAuthHandlerApi.d.ts

framework for building configurable CLIs

import { ICommandArguments } from "../../../../cmd";
import { AbstractSession, IOptionsForAddConnProps, ISession } from "../../../../rest";
/**
 * Auth handler API that provides convenient functions to create a session from
 * args, and use it to login or logout of an auth service.
 */
export interface IAuthHandlerApi {
    /**
     * Prompting options for adding connection properties.
     * The properties `defaultTokenType` and `serviceDescription` should be defined.
     */
    promptParams: IOptionsForAddConnProps;
    /**
     * Method to create a session config object from CLI arguments.
     * This is equivalent to the handler method `createSessCfgFromArgs`.
     */
    createSessCfg: (args: ICommandArguments) => ISession;
    /**
     * Method to login to authentication service with a session.
     * This is equivalent to the handler method `doLogin`.
     */
    sessionLogin: (session: AbstractSession) => Promise<string>;
    /**
     * Method to logout of authentication service with a session.
     * This is equivalent to the handler method `doLogout`.
     */
    sessionLogout: (session: AbstractSession) => Promise<void>;
}
//# sourceMappingURL=IAuthHandlerApi.d.ts.map