Class SimpleAuthenticationDetailsProvider

The API based authentication details provider which implements AuthenticationDetailsProvider.

Hierarchy

SimpleAuthenticationDetailsProvider

Implements

Constructors

constructor

Properties

Methods

Constructors

constructor

new SimpleAuthenticationDetailsProvider(tenancy: string, user: string, fingerprint: string, privateKey: string, passphrase: string | null, region?: Region): SimpleAuthenticationDetailsProvider

- Defined in lib/common/lib/auth/auth.ts:52
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
Returns SimpleAuthenticationDetailsProvider

Properties

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 region

region: Region

Private tenancy

tenancy: string

tenancy id.

Private user

user: string

user id.

Methods

getFingerprint

getFingerprint(): string

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

Returns string

getKeyId

getKeyId(): string

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

Returns string

getRegion

getRegion(): Region

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

Returns Region

getTenantId

getTenantId(): string

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

Returns string

getUser

getUser(): string

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

Returns string