IAuthHandlerApi | Zowe Node.js SDK

Auth handler API that provides convenient functions to create a session from args, and use it to login or logout of an auth service.

Index

createSessCfg: (args: ICommandArguments) => ISession

Method to create a session config object from CLI arguments. This is equivalent to the handler method createSessCfgFromArgs.

Prompting options for adding connection properties. The properties defaultTokenType and serviceDescription should be defined.

sessionLogin: (session: AbstractSession) => Promise<string>

Method to login to authentication service with a session. This is equivalent to the handler method doLogin.

- (session: AbstractSession): Promise<string>
- Parameters
  - session: AbstractSession
  Returns Promise<string>

sessionLogout: (session: AbstractSession) => Promise<void>

Method to logout of authentication service with a session. This is equivalent to the handler method doLogout.

- (session: AbstractSession): Promise<void>
- Parameters
  - session: AbstractSession
  Returns Promise<void>