Namespace TapjawAuthenticator

namespace: TapjawAuthenticator

References

TapjawAuthenticationWrapper

Re-exports TapjawAuthenticationWrapper

Functions

createBasicSecurity

createBasicSecurity(username: string, password: string): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:23
Parameters
- username: string
- password: string
Returns TapjawAuthenticationWrapper

createBearerSecurity

createBearerSecurity(token: string): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:26
Parameters
- token: string
Returns TapjawAuthenticationWrapper

createCustomHeaderSecurity

createCustomHeaderSecurity(name: string, value: string): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:32
Parameters
- name: string
- value: string
Returns TapjawAuthenticationWrapper

createCustomHeadersSecurity

createCustomHeadersSecurity(headers: CustomHeaders[]): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:35
Parameters
- headers: CustomHeaders[]
Returns TapjawAuthenticationWrapper

createJWTSecurity

createJWTSecurity(jwtBuilder: JWTBuilder): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:96
Parameters
- jwtBuilder: JWTBuilder
Returns TapjawAuthenticationWrapper

createOAuthRefreshSecurity

createOAuthRefreshSecurity(clientId: string, clientSecret: string, hostname: string, path: string, postParams: Record<string, string>, method?: string, responseEncoding?: BufferEncoding): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:75
Parameters
- clientId: string
- clientSecret: string
- hostname: string
- path: string
- postParams: Record<string, string>
- method: string = 'POST'
- responseEncoding: BufferEncoding = 'utf8'
Returns TapjawAuthenticationWrapper

createOAuthSecurity

createOAuthSecurity(clientId: string, clientSecret: string, hostname: string, path: string, postParams: Record<string, string>, method?: string, responseEncoding?: BufferEncoding): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:62
Parameters
- clientId: string
- clientSecret: string
- hostname: string
- path: string
- postParams: Record<string, string>
- method: string = 'POST'
- responseEncoding: BufferEncoding = 'utf8'
Returns TapjawAuthenticationWrapper

createPrefetchTokenAuthorizationHeadersSecurity

createPrefetchTokenAuthorizationHeadersSecurity(apiKey: string, hostname: string, path: string, method: string): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:52
Parameters
- apiKey: string
- hostname: string
- path: string
- method: string
Returns TapjawAuthenticationWrapper

createQueryParamterPrefetchTokenSecurity

createQueryParamterPrefetchTokenSecurity(queryParameterName: string, hostname: string, uri: string, method: string, jsonPathToToken: string, queryParameters?: Record<string, string>, headers?: Record<string, string>): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:38
Parameters
- queryParameterName: string
- hostname: string
- uri: string
- method: string
- jsonPathToToken: string
- queryParameters: Record<string, string> = {}
- headers: Record<string, string> = {}
Returns TapjawAuthenticationWrapper

createQueryStringSecurity

createQueryStringSecurity(queryParameters: QueryParameters): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:100
Parameters
- queryParameters: QueryParameters
Returns TapjawAuthenticationWrapper

createSimpleAuthorizationHeaderSecurity

createSimpleAuthorizationHeaderSecurity(token: string): TapjawAuthenticationWrapper

- Defined in src/support/create-security.ts:29
Parameters
- token: string
Returns TapjawAuthenticationWrapper

Generated using TypeDoc