Class ConfigFileAuthenticationDetailsProvider

Hierarchy

ConfigFileAuthenticationDetailsProvider
- SessionAuthDetailProvider

Implements

Constructors

constructor

Properties

delegate

Accessors

sessionToken

Methods

Constructors

constructor

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

- Defined in lib/common/lib/auth/config-file-auth.ts:22
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

Accessors

sessionToken

get sessionToken(): string | undefined
set sessionToken(token: undefined | string): void

- Defined in lib/common/lib/auth/config-file-auth.ts:240
Returns string | undefined
- Defined in lib/common/lib/auth/config-file-auth.ts:244
Parameters
- token: undefined | string
Returns void

Methods

createConfigFileAuth

createConfigFileAuth(file: ConfigFile): SimpleAuthenticationDetailsProvider

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

getAuthType

getAuthType(): string | undefined

Implementation of AuthenticationDetailsProvider.getAuthType
- Defined in lib/common/lib/auth/config-file-auth.ts:214
Get the authType

Returns string | undefined

getDelegationToken

getDelegationToken(): string | undefined

Implementation of AuthenticationDetailsProvider.getDelegationToken
- Defined in lib/common/lib/auth/config-file-auth.ts:232
Returns string | undefined

getFingerprint

getFingerprint(): string

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

Returns string

getKeyId

getKeyId(): Promise<string>

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

Returns Promise<string>

getPassphrase

getPassphrase(): string | null

Implementation of AuthenticationDetailsProvider.getPassphrase
- Defined in lib/common/lib/auth/config-file-auth.ts:172
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:165
Get the private key to sign the http request.

Returns string

getProfileCredentials

getProfileCredentials(): ConfigAccumulator | undefined

- Defined in lib/common/lib/auth/config-file-auth.ts:236
Returns ConfigAccumulator | undefined

getProvider

getProvider(): AuthenticationDetailsProvider

Implementation of AuthenticationDetailsProvider.getProvider
- Defined in lib/common/lib/auth/config-file-auth.ts:228
Get the provider

Returns AuthenticationDetailsProvider

getPvtKey

getPvtKey(filePath: string): string

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

getRegion

getRegion(): Region

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

Returns Region

getTenantId

getTenantId(): string

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

Returns string

getUser

getUser(): string

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

Returns string

retrieveRegionFromRegionId

retrieveRegionFromRegionId(regionId: string): Region

- Defined in lib/common/lib/auth/config-file-auth.ts:53
Get a region based on regionId, if corresponding region is not found from regionId, create a new region by registering regionId with Realm.OC1

return:

Region

Parameters
- regionId: string
Returns Region

setProvider

setProvider(provider: AuthenticationDetailsProvider): void

Implementation of AuthenticationDetailsProvider.setProvider
- Defined in lib/common/lib/auth/config-file-auth.ts:221
Set the provider

Parameters
- provider: AuthenticationDetailsProvider
Returns void

setRegion

setRegion(regionId: string): void

- Defined in lib/common/lib/auth/config-file-auth.ts:207
Set the region

Parameters
- regionId: string
Returns void