Class ConfigFileAuthenticationDetailsProvider

Hierarchy

ConfigFileAuthenticationDetailsProvider

Implements

Constructors

constructor

Properties

delegate

Methods

Constructors

constructor

new ConfigFileAuthenticationDetailsProvider(configurationFilePath?: undefined | string, profile?: undefined | string): ConfigFileAuthenticationDetailsProvider

- Defined in lib/common/lib/auth/config-file-auth.ts:19
Creates a new instance using the config file at the default location, see {@link ConfigFileReader#DEFAULT_FILE_PATH}.

throws

Error if the configuration file could not be loaded

Parameters
- Optional configurationFilePath: undefined | string
```
       config file path, optional
```
- Optional profile: undefined | string
```
       profile to load, optional
```
Returns ConfigFileAuthenticationDetailsProvider

Properties

Private delegate

delegate: SimpleAuthenticationDetailsProvider

Methods

createConfigFileAuth

createConfigFileAuth(file: ConfigFile): SimpleAuthenticationDetailsProvider

- Defined in lib/common/lib/auth/config-file-auth.ts:43
Parameters
- file: ConfigFile
Returns SimpleAuthenticationDetailsProvider

getFingerprint

getFingerprint(): string

- Defined in lib/common/lib/auth/config-file-auth.ts:120
Get the fingerprint

Returns string

getKeyId

getKeyId(): string

Implementation of AuthenticationDetailsProvider.getKeyId
- Defined in lib/common/lib/auth/config-file-auth.ts:85
Get the key id to sign the http request.

Returns string

getPassphrase

getPassphrase(): string | null

Implementation of AuthenticationDetailsProvider.getPassphrase
- Defined in lib/common/lib/auth/config-file-auth.ts:99
Get the passphrase of the private key to sign the http request.

Returns string | null

getPrivateKey

getPrivateKey(): string

Implementation of AuthenticationDetailsProvider.getPrivateKey
- Defined in lib/common/lib/auth/config-file-auth.ts:92
Get the private key to sign the http request.

Returns string

getPvtKey

getPvtKey(filePath: string): string

- Defined in lib/common/lib/auth/config-file-auth.ts:77
Parameters
- filePath: string
Returns string

getRegion

getRegion(): Region

Implementation of RegionProvider.getRegion
- Defined in lib/common/lib/auth/config-file-auth.ts:127
Get the rehion

Returns Region

getTenantId

getTenantId(): string

- Defined in lib/common/lib/auth/config-file-auth.ts:106
Get the Tenancy

Returns string

getUser

getUser(): string

- Defined in lib/common/lib/auth/config-file-auth.ts:113
Get the user

Returns string