Skip to content

Type Alias: HttpAuth ​

ts
type HttpAuth = 
  | HttpNoAuth
  | HttpBasicAuth
  | HttpBearerAuth
  | HttpApiKeyAuth
  | HttpDigestAuth
  | HttpAwsSignatureAuth
  | HttpHawkAuth
  | HttpJwtAuth
  | HttpAkamaiEdgeGridAuth;

How the host authenticates a request to the vendor, shaped like Hoppscotch's auth object. The fields that hold a credential take ctx.secret(name): the host fills the placeholders and builds the auth over the request it is about to send. The module never sees a secret, a key, a signature or a token. What the host derives from the secrets (an encoded credential, a signature, a token) is redacted like the secrets themselves, and reads [auth:TYPE]. A request that sets a header the auth sets too, or whose URL has a query parameter the auth adds, is refused.

Released under the Apache-2.0 License.