Jump to Content

olp-sdk-authentication | @here/olp-sdk-ts

olp-sdk-authentication | @here/olp-sdk-ts

Module olp-sdk-authentication

Index

Classes

UserAuth

Interfaces

Type Aliases

TokenRequesterFn

Functions

Type Aliases

TokenRequesterFn

TokenRequesterFn: ((args: OAuthArgs) => Promise<Token>)

Type declaration

- (args: OAuthArgs): Promise<Token>
- Gets an access token.
  
  Parameters
  - args: OAuthArgs
    
    The arguments needed to get the access token.
  Returns Promise<Token>
  The generated access token.

Functions

loadCredentialsFromFile

loadCredentialsFromFile(path: string): AuthCredentials

- Defined in @here/olp-sdk-authentication/lib/loadCredentialsFromFile.ts:32
Parses the credentials.properties file from the HERE platform and retrieves an object with user credentials.

throws
An error if the parsing is not successful.

Parameters
- path: string
  
  The path to the credentials.properties file.
Returns AuthCredentials
The object with the access key ID and access key secret.

requestToken

requestToken(args: OAuthArgs): Promise<Token>

- Defined in @here/olp-sdk-authentication/lib/requestToken.ts:39
Creates an access token.

Parameters
- args: OAuthArgs
  
  The arguments needed to get the access token.
Returns Promise<Token>
The generated access token.

Generated using TypeDoc