### Hierarchy

- ProfileCredentials

## Index

### Constructors

- constructor

### Properties

- mCredMgrOverride
- mOnlyCheckActiveLayer
- mProfileInfo
- mSecured

### Accessors

- isSecured

### Methods

- activateCredMgrOverride
- isCredentialManagerInAppSettings
- isTeamConfigSecure
- loadManager
- defaultCredMgrWithKeytar

## Constructors

### constructor

- new ProfileCredentials(mProfileInfo: ProfileInfo, opts?: IProfOpts | (() => Module)): ProfileCredentials

- - Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:24

  #### Parameters

  - ##### mProfileInfo: ProfileInfo

  - ##### Optional opts: IProfOpts | (() => Module)

  #### Returns ProfileCredentials

## Properties

### Private Optional mCredMgrOverride

mCredMgrOverride: ICredentialManagerInit

- Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:23

### Private Optional mOnlyCheckActiveLayer

mOnlyCheckActiveLayer: boolean

- Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:24

### Private mProfileInfo

mProfileInfo: ProfileInfo

- Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:26

### Private mSecured

mSecured: boolean

- Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:22

## Accessors

### isSecured

- get isSecured(): boolean

- - Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:68

  Check if secure credentials will be encrypted or stored in plain text. This will return true if the team configuration files contain secure fields, or if a custom CredentialManager is defined in the Imperative settings.json file.

  #### Returns boolean

## Methods

### activateCredMgrOverride

- activateCredMgrOverride(): Promise<void>

- - Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:99

  Attempt to initialize `CredentialManagerFactory` with the specified override.

  internal

  #### Returns Promise<void>

### isCredentialManagerInAppSettings

- isCredentialManagerInAppSettings(): boolean

- - Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:127

  Check whether a custom CredentialManager is defined in the Imperative settings.json file.

  internal

  #### Returns boolean

### Private isTeamConfigSecure

- isTeamConfigSecure(): boolean

- - Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:118

  Check whether a teamConfig is secure or not

  #### Returns boolean

  False if not using teamConfig or there are no secure fields

### loadManager

- loadManager(): Promise<void>

- - Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:79

  Initialize credential manager to be used for secure credential storage. This method throws if ProfileCredentials.isSecured is false. If the CredentialManagerFactory is already initialized, it is reused since it is not possible to reinitialize.

  #### Returns Promise<void>

### Static defaultCredMgrWithKeytar

- defaultCredMgrWithKeytar(requireKeytar: () => Module): ICredentialManagerInit

- - Defined in @zowe/imperative/src/config/src/ProfileCredentials.ts:44

  Given a custom method to require Keytar, return an object that defines credential manager settings to replace the default credential manager. If the credential manager is not overridden, the default implementation is to `require("keytar")` from the caller app's node_modules folder.

  #### Parameters

  - ##### requireKeytar: () => Module

    Callback to require Keytar module for managing secure credentials

    - - (): Module

      - #### Returns Module

  #### Returns ICredentialManagerInit

  Credential manager settings with Keytar module overridden

Generated using TypeDoc