Class SimpleAuthenticationDetailsProvider

The API based authentication details provider which implements AuthenticationDetailsProvider.

Hierarchy

SimpleAuthenticationDetailsProvider

Implements

Constructors

constructor

Properties

Accessors

sessionToken

Methods

Constructors

constructor

new SimpleAuthenticationDetailsProvider(tenancy: string, user: string, fingerprint: string, privateKey: string, passphrase: string | null, region?: Region, authType?: string | undefined, delegationToken?: string | undefined, profileCredentials?: ConfigAccumulator | undefined, _sessionToken?: string | undefined): SimpleAuthenticationDetailsProvider

- Defined in lib/common/lib/auth/auth.ts:77
Construct an instance of SimpleAuthenticationDetailsProvider.

Parameters
- tenancy: string
  
  tenancy id.
- user: string
  
  user id.
- fingerprint: string
  
  user's fingerprint.
- privateKey: string
  
  private key to sign the request.
- passphrase: string | null
  
  the passphrase of private key.
- Optional region: Region
- Optional authType: string | undefined
- Optional delegationToken: string | undefined
- Optional profileCredentials: ConfigAccumulator | undefined
- Optional _sessionToken: string | undefined
Returns SimpleAuthenticationDetailsProvider

Properties

Private Optional _sessionToken

_sessionToken: string | undefined

Private Optional authType

authType: string | undefined

Private Optional delegationToken

delegationToken: string | undefined

Private fingerprint

fingerprint: string

user's fingerprint.

Private passphrase

passphrase: string | null

the passphrase of private key.

Private privateKey

privateKey: string

private key to sign the request.

Private Optional profileCredentials

profileCredentials: ConfigAccumulator | undefined

Private provider

provider: AuthenticationDetailsProvider = (null as unknown) as AuthenticationDetailsProvider

Private Optional region

region: Region

Private tenancy

tenancy: string

tenancy id.

Private user

user: string

user id.

Accessors

sessionToken

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

- Defined in lib/common/lib/auth/auth.ts:187
Returns string | undefined
- Defined in lib/common/lib/auth/auth.ts:191
Parameters
- token: undefined | string
Returns void

Methods

getAuthType

getAuthType(): string | undefined

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

Returns string | undefined

getDelegationToken

getDelegationToken(): string | undefined

Implementation of AuthenticationDetailsProvider.getDelegationToken
- Defined in lib/common/lib/auth/auth.ts:179
Get the delegation token

Returns string | undefined

getFingerprint

getFingerprint(): string

- Defined in lib/common/lib/auth/auth.ts:137
Get the fingerprint

Returns string

getKeyId

getKeyId(): Promise<string>

Implementation of AuthenticationDetailsProvider.getKeyId
- Defined in lib/common/lib/auth/auth.ts:102
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/auth.ts:116
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/auth.ts:109
Get the private key to sign the http request.

Returns string

getProfileCredentials

getProfileCredentials(): ConfigAccumulator | undefined

- Defined in lib/common/lib/auth/auth.ts:183
Returns ConfigAccumulator | undefined

getProvider

getProvider(): AuthenticationDetailsProvider

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

Returns AuthenticationDetailsProvider

getRegion

getRegion(): Region

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

Returns Region

getTenantId

getTenantId(): string

- Defined in lib/common/lib/auth/auth.ts:123
Get the Tenancy

Returns string

getUser

getUser(): string

- Defined in lib/common/lib/auth/auth.ts:130
Get the user

Returns string

setProvider

setProvider(provider: AuthenticationDetailsProvider): void

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

Parameters
- provider: AuthenticationDetailsProvider
Returns void

setRegion

setRegion(region: Region): void

- Defined in lib/common/lib/auth/auth.ts:151
Set the region

Parameters
- region: Region
Returns void