@zowe/imperative/lib/rest/src/session/doc/ISession.d.ts

framework for building configurable CLIs

import * as SessConstants from "../SessConstants";
import { ProxyVariables } from "./ProxyVariables";
import { IAuthCache } from "./IAuthCache";
/**
 * Session interface for maintaining cookie and protocol information
 * @export
 * @interface ISession
 */
export interface ISession {
    /**
     * Host to get data from, not including http(s) from a URL, e.g. jsonplaceholder.typicode.com
     * @type {string}
     * @memberof ISession
     */
    hostname?: string;
    /**
     * Port to obtain data from
     * 80 is the default for http
     * 443 is the default 443 for https
     * @type {number}
     * @memberof ISession
     */
    port?: number;
    /**
     * User name for logging in
     * @type {string}
     * @memberof ISession
     */
    user?: string;
    /**
     * Password
     * @type {string}
     * @memberof ISession
     */
    password?: string;
    /**
     * Currently only HTTPS is supported
     * @type {string}
     * @memberof ISession
     */
    protocol?: SessConstants.HTTP_PROTOCOL_CHOICES;
    /**
     * The base path (or first part) of the resources that we will access.
     * It is used to specify the first part of the resource in a URL that
     * points to any API mediation layer, gateway, or router used at a site
     * to dispatch web requests to services that are managed by that gateway.
     * It is pre-pended to the resource path of the underlying service.
     * When not supplied, or is an empty string we use the the resource path of
     * the underlying service directly.
     * @type {string}
     * @memberof ISession
     */
    basePath?: string;
    /**
     * Type of authentication, none is default
     * "none"  - no authorization header is used
     * "basic" - use basic auth for every request
     * "bearer" - use bearer auth for every request.
     *           Indicates use token value provided.
     * "token" - use cookie auth for every request.
     *           Indicates use token value provided and check for timeout / expiration
     *           if not token is provided, basic auth is used and the tokenType is obtained
     *           from the cookie header and stored as a token value to be used on subsequent
     *           requests
     * @type {string}
     * @memberof ISession
     */
    type?: SessConstants.AUTH_TYPE_CHOICES;
    /**
     * Base 64 encoded authentication materials created by base 64 encoding:
     *  Basic <user_name>:<password>
     * @type {string}
     * @memberof ISession
     */
    base64EncodedAuth?: string;
    /**
     * Type of token in `tokenValue`, e.g. LTPA2
     * @type {string}
     * @memberof ISession
     */
    tokenType?: string;
    /**
     * Token value of type `tokenType`
     * @type {string}
     * @memberof ISession
     */
    tokenValue?: string;
    /**
     * The following options map to TLS options available within the node.js TLS APIs, please
     * see the official Node.js documentation for these fields
     * @type {boolean}
     * @memberof ISession
     */
    rejectUnauthorized?: boolean;
    /**
     * The file path to the client certificate to use for authentication
     * @type {string}
     * @memberof ISession
     */
    cert?: string;
    /**
     * The file path to the client certificate's key to use for authentication
     * @type {string}
     * @memberof ISession
     */
    certKey?: string;
    /**
     * The passphrase used to access the client certificate, if in PFX format
     * @type {string}
     * @memberof ISession
     */
    passphrase?: string;
    /**
     * todo
     * @type {string}
     * @memberof ISession
     */
    serverCertificate?: string;
    /**
     * see node.js api
     * @type {boolean}
     * @memberof ISession
     */
    strictSSL?: boolean;
    /**
     * todo
     * @type {boolean}
     * @memberof ISession
     */
    checkServerIdentity?: (host: string, cert: object) => Error | undefined;
    /**
     * Default is SSLv23_method
     * @type {string}
     * @memberof ISession
     */
    secureProtocol?: string;
    /**
     * Decide whether or not to store a returned cookie.
     * Only applies to certificates for now.
     * @type {boolean}
     * @memberof ISession
     */
    storeCookie?: boolean;
    /**
     * Specifies the order of precedence for using different authentication types in this
     * session. The order in the array determines which credential type is preferred.
     * The type in authTypeOrder[0] is used first, authTypeOrder[1] second, etc.
     * Values are specified using SessConstants.AUTH_TYPE_XXX values.
     *
     * The authTypeOrder property is specified by the end user and is managed by
     * Zowe SDK functions. Consuming applications should not modify the contents
     * of the authTypeOrder property.
     *
     * @type {string[]}
     * @memberof ISession
     */
    authTypeOrder?: SessConstants.AUTH_TYPE_CHOICES[];
    /**
     * The _authCache property contains a cache of credentials which are available
     * for authentication. It also contains properties related to whether the user
     * supplied the authentication order or whether we are using a default order.
     *
     * The _authCache property is created and managed by Zowe SDK functions.
     * Consuming applications should not modify the contents of the _authCache property.
     *
     * @type number
     * @memberof ISession
     */
    _authCache?: IAuthCache;
    /**
     * Specifies external proxy settings
     * values will override environment variable proxy settings
     *
     * @type {ProxyVariables[]}
     * @memberof ISession
     */
    proxy?: ProxyVariables;
    /**
     * Specifies the number of milliseconds to wait for the initial socket connection to be established
     *
     * @type {number}
     * @memberof ISession
     */
    socketConnectTimeout?: number;
    /**
     * Specifies the number of milliseconds to wait for the request to complete
     *
     * @type {number}
     * @memberof ISession
     */
    requestCompletionTimeout?: number;
    /**
     * The callback if the request completion timeout occurs. Must be synchronous.
     *
     * @type {function}
     * @memberof ISession
     */
    requestCompletionTimeoutCallback?: () => void;
}
//# sourceMappingURL=ISession.d.ts.map