@acceleratxr/core_sdk / AuthBasicService

Class: AuthBasicService

Hierarchy

• ServiceBase

  ↳ AuthBasicService

Index

Constructors

• constructor

Properties

• apiClient

• config

• uuid

Methods

• authenticate

Constructors

constructor

+ new AuthBasicService(apiClient: ApiClient, config: Configuration): AuthBasicService

Overrides ServiceBase.constructor

Defined in src/services/AuthBasicService.ts:10

Parameters:

Name	Type
apiClient	ApiClient
config	Configuration

Returns: AuthBasicService

Properties

apiClient

• Protected apiClient: ApiClient

Inherited from ServiceBase.apiClient

Defined in src/ServiceBase.ts:14

The API Client used when making requests to the API backend server.

---

config

• Protected config: Configuration

Inherited from ServiceBase.config

Defined in src/ServiceBase.ts:19

The SDK configuration to use.

---

uuid

▪ Static uuid: string = “a7970e90-0e81-4514-8b29-520aef3987db”

Defined in src/services/AuthBasicService.ts:16

Methods

authenticate

▸ authenticate(username: string, password: string): Promise<AuthToken | undefined>

Defined in src/services/AuthBasicService.ts:21

Authenticates the user using HTTP Basic and returns a JSON Web Token access token to be used with future API requests.

Parameters:

Name	Type
username	string
password	string

Returns: Promise<AuthToken | undefined>