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

### Hierarchy

- IAuthHandlerApi

## Index

### Properties

- createSessCfg
- promptParams
- sessionLogin
- sessionLogout

## Properties

### createSessCfg

createSessCfg: (args: ICommandArguments) => ISession

- Defined in @zowe/imperative/src/imperative/src/auth/doc/IAuthHandlerApi.ts:30

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

#### Type declaration

- - (args: ICommandArguments): ISession

  - #### Parameters

    - ##### args: ICommandArguments

    #### Returns ISession

### promptParams

promptParams: IOptionsForAddConnProps

- Defined in @zowe/imperative/src/imperative/src/auth/doc/IAuthHandlerApi.ts:24

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

### sessionLogin

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

- Defined in @zowe/imperative/src/imperative/src/auth/doc/IAuthHandlerApi.ts:36

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

#### Type declaration

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

  - #### Parameters

    - ##### session: AbstractSession

    #### Returns Promise<string>

### sessionLogout

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

- Defined in @zowe/imperative/src/imperative/src/auth/doc/IAuthHandlerApi.ts:42

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

#### Type declaration

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

  - #### Parameters

    - ##### session: AbstractSession

    #### Returns Promise<void>

Generated using TypeDoc