Interface AuthenticationDetailsProvider

An interface provides the authentication details.

Hierarchy

AbstractAuthenticationDetailsProvider
- AuthenticationDetailsProvider

Implemented by

Methods

Methods

Optional getAuthType

getAuthType(): string | undefined

- Defined in lib/common/lib/auth/auth.ts:32
Get the auth type of this authentication provider

Returns string | undefined

Optional getDelegationToken

getDelegationToken(): string | undefined

- Defined in lib/common/lib/auth/auth.ts:47
Get the delegation token

Returns string | undefined

getKeyId

getKeyId(): Promise<string>

- Defined in lib/common/lib/auth/auth.ts:17
Get the key id to sign the http request.

Returns Promise<string>

getPassphrase

getPassphrase(): string | null

- Defined in lib/common/lib/auth/auth.ts:27
Get the passphrase of the private key to sign the http request.

Returns string | null

getPrivateKey

getPrivateKey(): string

- Defined in lib/common/lib/auth/auth.ts:22
Get the private key to sign the http request.

Returns string

Optional getProvider

getProvider(): AuthenticationDetailsProvider

- Defined in lib/common/lib/auth/auth.ts:37
Get the true authentication provider

Returns AuthenticationDetailsProvider

Optional setProvider

setProvider(provider: AuthenticationDetailsProvider): void

- Defined in lib/common/lib/auth/auth.ts:42
Set the provider

Parameters
- provider: AuthenticationDetailsProvider
Returns void