Class ApiKeyCredentials

Package version

Authenticates to a service using an API key.

Hierarchy

ApiKeyCredentials
- TopicCredentials

Implements

ServiceClientCredentials

Index

Constructors

constructor

Methods

signRequest

Constructors

constructor

new ApiKeyCredentials(options: ApiKeyCredentialOptions): ApiKeyCredentials

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/credentials/apiKeyCredentials.ts:33
Parameters
- options: ApiKeyCredentialOptions
  
  Specifies the options to be provided for auth. Either header or query needs to be provided.
Returns ApiKeyCredentials

Methods

signRequest

signRequest(webResource: WebResourceLike): Promise<WebResourceLike>

Implementation of ServiceClientCredentials.signRequest
- Defined in home/vsts/work/1/s/sdk/core/core-http/src/credentials/apiKeyCredentials.ts:54
Signs a request with the values provided in the inHeader and inQuery parameter.

Parameters
- webResource: WebResourceLike
  
  The WebResourceLike to be signed.
Returns Promise<WebResourceLike>

The signed request object.

Generated using TypeDoc