Class ApiKeyAuthAuthentication

Applies apiKey authentication to the request context.

Hierarchy

ApiKeyAuthAuthentication

Implements

SecurityAuthentication

Index

Constructors

Properties

Methods

applySecurityAuthentication getName

Constructors

constructor

new ApiKeyAuthAuthentication(apiKey: string): ApiKeyAuthAuthentication
Configures this api key authentication with the necessary properties
Parameters
- apiKey: string
Returns ApiKeyAuthAuthentication
- Defined in packages/datadog-api-client-common/auth.ts:53

Properties

`Private` apiKey

apiKey: string

Methods

applySecurityAuthentication

applySecurityAuthentication(context: RequestContext): void
Applies the authentication scheme to the request context

Params
context the request context which should use this authentication scheme
Parameters
- context: RequestContext
Returns void
Implementation of SecurityAuthentication.applySecurityAuthentication
- Defined in packages/datadog-api-client-common/auth.ts:59

getName

getName(): string
Returns string
Implementation of SecurityAuthentication.getName
- Defined in packages/datadog-api-client-common/auth.ts:55

Generated using TypeDoc