Class DigitalOceanApiKeyAuthenticationProvider

Authenticate a request by using an API Key

Implements

AuthenticationProvider

Index

Constructors

Methods

authenticateRequest

Constructors

constructor

new DigitalOceanApiKeyAuthenticationProvider(
apiKey: string,
): DigitalOceanApiKeyAuthenticationProvider
Parameters
- apiKey: string
  The API Key to use for authentication
Returns DigitalOceanApiKeyAuthenticationProvider
- Defined in src/dots/DigitalOceanApiKeyAuthenticationProvider.ts:9

Methods

authenticateRequest

authenticateRequest(
request: RequestInformation,
additionalAuthenticationContext?: Record<string, unknown>,
): Promise<void>
Authenticates the application and returns a token base on the provided Uri.
Parameters
- request: RequestInformation
  the request to authenticate.
- OptionaladditionalAuthenticationContext: Record<string, unknown>
  The additional authentication context to pass to the authentication library.
Returns Promise<void>
a Promise to await for the authentication to be completed.
Implementation of AuthenticationProvider.authenticateRequest
- Defined in src/dots/DigitalOceanApiKeyAuthenticationProvider.ts:16