Jump to Content

UserAuth | @here/olp-sdk-ts

UserAuth | @here/olp-sdk-ts

Class UserAuth

Used to get and validate an access token, and to get user data.

Hierarchy

UserAuth

Index

Constructors

constructor

Methods

Constructors

constructor

new UserAuth(config: UserAuthConfig): UserAuth

- Defined in @here/olp-sdk-authentication/lib/UserAuth.ts:159
Creates the UserAuth instance.

Parameters
- config: UserAuthConfig
  
  Parameters for authentication.
Returns UserAuth
The UserAuth instance.

Methods

getToken

getToken(): Promise<string>

- Defined in @here/olp-sdk-authentication/lib/UserAuth.ts:201
Retrieves the access token.

Returns Promise<string>
The access token if it is valid, or an error if at least one of the following credentials is not stated: access key ID or access key secret.

getUserInfo

getUserInfo(userToken: string): Promise<UserInfo>

- Defined in @here/olp-sdk-authentication/lib/UserAuth.ts:281
Retrieves user data.

Parameters
- userToken: string
  
  The string that contains the user token.
Returns Promise<UserInfo>
The json object with the user data.

validateAccessToken

validateAccessToken(token: string): Promise<string | boolean>

- Defined in @here/olp-sdk-authentication/lib/UserAuth.ts:247
Validates the access token.

Parameters
- token: string
  
  The string containing the token.
Returns Promise<string | boolean>
True if the access token is valid, false otherwise.

Generated using TypeDoc