Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiKeyCredentials

Package version

Authenticates to a service using an API key.

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

  • constructor

    Parameters

    • options: ApiKeyCredentialOptions

      Specifies the options to be provided for auth. Either header or query needs to be provided.

    Returns ApiKeyCredentials

Methods

signRequest

  • Signs a request with the values provided in the inHeader and inQuery parameter.

    Parameters

    • webResource: WebResource

      The WebResource to be signed.

    Returns Promise<WebResource>

    The signed request object.

Generated using TypeDoc