Class AhoiClientTokenService

Hierarchy

AbstractAhoiAuthenticationService
- AhoiClientTokenService

Index

Constructors

constructor

Properties

Methods

authenticate

Constructors

constructor

new AhoiClientTokenService(config: AhoiConfig, baseUrl: string): AhoiClientTokenService

Inherited from AbstractAhoiAuthenticationService.constructor
- Defined in ahoi/auth/abstractauth.ts:13
Parameters
- config: AhoiConfig
- baseUrl: string
Returns AhoiClientTokenService

Properties

Static AUTH_CREDENTIALS_PARAMETER

AUTH_CREDENTIALS_PARAMETER: "grant_type=client_credentials" = "grant_type=client_credentials"

Static AUTH_URI

AUTH_URI: string = "/auth/v1/oauth/token"

Methods

authenticate

authenticate(): Promise<Token>

- Defined in ahoi/auth/clienttokenauth.ts:18
Authenticate and authorize the client using clientId and client-Secret against AHOI using the OAuth 2.0 protocol.
The returned authorization token is needed to register new users.
see: https://banking-sandbox.starfinanz.de/ahoi/docs/cookbook/index.html#authentication

memberof

AhoiClientTokenService

Returns Promise<Token>