A cache of authentication items that are created and maintained by the Zowe client infrastructure within an ISession object. Consuming applications should not modify the contents of an IAuthCache object.

export
interface

  IAuthCache

### Hierarchy

- IAuthCache

## Index

### Properties

- authTypeToRequestToken
- availableCreds
- didUserSetAuthOrder
- topDefaultAuth

## Properties

### Optional authTypeToRequestToken

authTypeToRequestToken: typeof AUTH_TYPE_NONE | typeof AUTH_TYPE_BASIC | typeof AUTH_TYPE_CERT_PEM

- Defined in @zowe/imperative/src/rest/src/session/doc/IAuthCache.ts:48

When present, authTypeToRequestToken indicates that we want to request a token. It also tells us what type of authentication should be used to get that token. AUTH_TYPE_NONE is an early placeholder (when needed), which Zowe API logic automatically replaces with an appropriate value. This property is only used during a login command. Otherwise, this property is not placed into the cache.

### availableCreds

availableCreds: {}

- Defined in @zowe/imperative/src/rest/src/session/doc/IAuthCache.ts:26

This property holds the set of all credentials that are available for the REST request currently being processed.

#### Type declaration

- ##### [credName: string]: string

### didUserSetAuthOrder

didUserSetAuthOrder: boolean

- Defined in @zowe/imperative/src/rest/src/session/doc/IAuthCache.ts:33

Indicates whether the user has supplied the authentication order.

### topDefaultAuth

topDefaultAuth: typeof AUTH_TYPE_BASIC | typeof AUTH_TYPE_TOKEN

- Defined in @zowe/imperative/src/rest/src/session/doc/IAuthCache.ts:38

Contains the authentication to be placed at the top of a default auth order.

Generated using TypeDoc