Class SessionAuthDetailProvider

Hierarchy

ConfigFileAuthenticationDetailsProvider
- SessionAuthDetailProvider

Implements

Constructors

constructor

Accessors

sessionToken

Methods

Constructors

constructor

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

Overrides ConfigFileAuthenticationDetailsProvider.constructor
- Defined in lib/common/lib/auth/session-auth-details-provider.ts:10
Parameters
- Optional configurationFilePath: undefined | string
- Optional profile: undefined | string
Returns SessionAuthDetailProvider

Accessors

sessionToken

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

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

Methods

createConfigFileAuth

createConfigFileAuth(file: ConfigFile): SimpleAuthenticationDetailsProvider

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

getAuthType

getAuthType(): string | undefined

Implementation of AuthenticationDetailsProvider.getAuthType

Inherited from ConfigFileAuthenticationDetailsProvider.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

Inherited from ConfigFileAuthenticationDetailsProvider.getDelegationToken
- Defined in lib/common/lib/auth/config-file-auth.ts:232
Returns string | undefined

getFingerprint

getFingerprint(): string

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

Returns string

getKeyId

getKeyId(): Promise<string>

Implementation of AuthenticationDetailsProvider.getKeyId

Overrides ConfigFileAuthenticationDetailsProvider.getKeyId
- Defined in lib/common/lib/auth/session-auth-details-provider.ts:15
Returns Promise<string>

getPassphrase

getPassphrase(): string | null

Implementation of AuthenticationDetailsProvider.getPassphrase

Inherited from ConfigFileAuthenticationDetailsProvider.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

Inherited from ConfigFileAuthenticationDetailsProvider.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

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

getProvider

getProvider(): AuthenticationDetailsProvider

Implementation of AuthenticationDetailsProvider.getProvider

Inherited from ConfigFileAuthenticationDetailsProvider.getProvider
- Defined in lib/common/lib/auth/config-file-auth.ts:228
Get the provider

Returns AuthenticationDetailsProvider

getPvtKey

getPvtKey(filePath: string): string

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

getRegion

getRegion(): Region

Implementation of RegionProvider.getRegion

Inherited from ConfigFileAuthenticationDetailsProvider.getRegion
- Defined in lib/common/lib/auth/config-file-auth.ts:200
Get the region

Returns Region

getSecurityToken

getSecurityToken(): Promise<string>

- Defined in lib/common/lib/auth/session-auth-details-provider.ts:19
Returns Promise<string>

getTenantId

getTenantId(): string

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

Returns string

getUser

getUser(): string

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

Returns string

refreshSessionToken

refreshSessionToken(): Promise<string>

- Defined in lib/common/lib/auth/session-auth-details-provider.ts:23
Returns Promise<string>

retrieveRegionFromRegionId

retrieveRegionFromRegionId(regionId: string): Region

Inherited from ConfigFileAuthenticationDetailsProvider.retrieveRegionFromRegionId
- 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

Inherited from ConfigFileAuthenticationDetailsProvider.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

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

Parameters
- regionId: string
Returns void