Class PreauthUriTokenAuthenticator

Hierarchy-Diagram

UML class diagram of PreauthUriTokenAuthenticator

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

PreauthUriTokenAuthenticator

Implements

TapjawAuthenticator<URIToken>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PreauthUriTokenAuthenticator(hostname: string, path: string, method?: string, tokenJsonPath: string, params?: {}, headers?: {}): PreauthUriTokenAuthenticator

- Defined in src/authenticators/preauth-uri-token-authenticator.ts:10
Parameters
- hostname: string
- path: string
- method: string = 'GET'
- tokenJsonPath: string
- params: {} = {}
- headers: {} = {}
Returns PreauthUriTokenAuthenticator

Properties

Protected Readonly headers

headers: {} = {}

Type declaration

Protected Readonly hostname

hostname: string

Protected Readonly method

method: string = 'GET'

Protected Readonly params

params: {} = {}

Type declaration

Protected Readonly path

path: string

Private token

token: string

Protected Readonly tokenJsonPath

tokenJsonPath: string

Methods

authenticate

authenticate(): Promise<string>

Implementation of TapjawAuthenticator.authenticate
- Defined in src/authenticators/preauth-uri-token-authenticator.ts:23
Run authentication routine and pass the authentication data into the connector.

Returns Promise<string>

isAuthenticated

isAuthenticated(): boolean

Implementation of TapjawAuthenticator.isAuthenticated
- Defined in src/authenticators/preauth-uri-token-authenticator.ts:19
Whether the authentication has occurred.

Returns boolean
boolean

Generated using TypeDoc