Class: AuthEndpoint

Defined in: api/endpoints/auth/AuthEndpoint.ts:15

Endpoints for interacting with auth.

Extends

• ApiEndpoint

Constructors

Constructor

new AuthEndpoint(config, tokenManager, log?, headerProvider?): AuthEndpoint

Defined in: api/endpoints/auth/AuthEndpoint.ts:16

Parameters

config

DefaultApiConfig

tokenManager

TokenManager

log?

Logger

headerProvider?

HeaderProvider

Returns

AuthEndpoint

Overrides

ApiEndpoint.constructor

Properties

config

readonly config: DefaultApiConfig

Defined in: api/endpoints/ApiEndpoint.ts:10

Inherited from

ApiEndpoint.config

---

log?

protected readonly optional log: Logger

Defined in: api/endpoints/ApiEndpoint.ts:15

Inherited from

ApiEndpoint.log

---

tokenManager

readonly tokenManager: TokenManager

Defined in: api/endpoints/ApiEndpoint.ts:14

Inherited from

ApiEndpoint.tokenManager

Methods

createApiToken()

createApiToken(newToken): Promise<ApiResponse<string>>

Defined in: api/endpoints/auth/AuthEndpoint.ts:49

Creates an api token.

Parameters

newToken

CreateApiTokenRequest

Emergency details for the new emergency

Returns

Promise<ApiResponse<string>>

The newly-created api token

---

deleteApiToken()

deleteApiToken(id): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/auth/AuthEndpoint.ts:62

Delete an api token.

Parameters

id

string

The id of the api token to delete

Returns

Promise<ApiResponse<unknown>>

---

deleteRequest()

protected deleteRequest(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/ApiEndpoint.ts:85

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<unknown>>

Inherited from

ApiEndpoint.deleteRequest

---

endpoint()

protected endpoint(): string

Defined in: api/endpoints/auth/AuthEndpoint.ts:20

Returns

string

Overrides

ApiEndpoint.endpoint

---

endpointUrl()

protected endpointUrl(): string

Defined in: api/endpoints/ApiEndpoint.ts:23

Returns

string

Inherited from

ApiEndpoint.endpointUrl

---

getApiTokens()

getApiTokens(): Promise<ApiResponse<ApiToken[]>>

Defined in: api/endpoints/auth/AuthEndpoint.ts:38

Gets all api tokens for the user.

Returns

Promise<ApiResponse<ApiToken[]>>

---

getRequest()

protected getRequest<T>(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:53

Type Parameters

T

T = unknown

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.getRequest

---

patchRequest()

protected patchRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:77

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.patchRequest

---

postRequest()

protected postRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:61

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.postRequest

---

putRequest()

protected putRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:69

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.putRequest

---

signOut()

signOut(oldToken?): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/auth/AuthEndpoint.ts:30

Invalidate a refresh token.

Parameters

oldToken?

SignOutRequest

Token to be invalidated

Returns

Promise<ApiResponse<unknown>>