Options
All
  • Public
  • Public/Protected
  • All
Menu

The base authentication contract.

This is used by Connectors to authenticate a connection prior to perform an API call.

Two common approaches are available in the Tapjaw Importer toolkit:

  1. Specify shared credentials such as username, password, secret, or a token.
  2. Execute a request to a separate authentication endpoint and then use a responded token, access key or secret to gain access to the API.

An additional unsupported method is also possible, using the session cookie in conjunction with a form login request, although this requires defining scraping rules for HTML responses and potentially querying for request tokens stored in a webpage to allow a login request.

Type parameters

  • T

Hierarchy-Diagram

UML class diagram of TapjawAuthenticator

Legend

icon for a class in the UML class diagram class
icon for an interface in the UML class diagram interface
icon for a protected property in the UML class diagram protected property
icon for a private property in the UML class diagram private property
icon for a public method in the UML class diagram public method

Hierarchy

  • TapjawAuthenticator

Implemented by

Index

Methods

  • isAuthenticated(): boolean

Generated using TypeDoc