Skip to content

PERS SDK - v2.3.26 / Exports / ExtendedTokenStorageProvider

Interface: ExtendedTokenStorageProvider

Extended interface for providers that support additional token types and auth configuration

Hierarchy

Table of contents

Methods

Properties

Methods

getToken

getToken(): Promise<null | string>

Get current access token

Returns

Promise<null | string>

Inherited from

TokenStorageProvider.getToken

Defined in

core/auth/auth-provider.interface.ts:17


getProjectKey

getProjectKey(): Promise<null | string>

Get project key for API requests

Returns

Promise<null | string>

Inherited from

TokenStorageProvider.getProjectKey

Defined in

core/auth/auth-provider.interface.ts:20


onAuthStatusChange

onAuthStatusChange(status): Promise<void>

Handle authentication status changes

Parameters

NameType
statusAuthStatus

Returns

Promise<void>

Inherited from

TokenStorageProvider.onAuthStatusChange

Defined in

core/auth/auth-provider.interface.ts:23


getAuthHeaders

getAuthHeaders(token, method?, url?): Promise<Record<string, string>>

Get derived authentication headers (e.g. DPoP)

Parameters

NameTypeDescription
tokennull | stringThe current access token
method?stringHTTP Method
url?stringRequest URL

Returns

Promise<Record<string, string>>

Inherited from

TokenStorageProvider.getAuthHeaders

Defined in

core/auth/auth-provider.interface.ts:31


setAccessToken

setAccessToken(token): Promise<void>

Parameters

NameType
tokenstring

Returns

Promise<void>

Inherited from

TokenStorageProvider.setAccessToken

Defined in

core/auth/auth-provider.interface.ts:38


setRefreshToken

setRefreshToken(token): Promise<void>

Parameters

NameType
tokenstring

Returns

Promise<void>

Inherited from

TokenStorageProvider.setRefreshToken

Defined in

core/auth/auth-provider.interface.ts:39


getRefreshToken

getRefreshToken(): Promise<null | string>

Returns

Promise<null | string>

Inherited from

TokenStorageProvider.getRefreshToken

Defined in

core/auth/auth-provider.interface.ts:40


clearTokens

clearTokens(): Promise<void>

Returns

Promise<void>

Inherited from

TokenStorageProvider.clearTokens

Defined in

core/auth/auth-provider.interface.ts:41


setProviderToken

setProviderToken(token): Promise<void>

Parameters

NameType
tokenstring

Returns

Promise<void>

Defined in

core/auth/auth-provider.interface.ts:48


setAuthType

setAuthType(authType): Promise<void>

Parameters

NameType
authTypeAccountOwnerType

Returns

Promise<void>

Defined in

core/auth/auth-provider.interface.ts:49


getAuthType

getAuthType(): Promise<null | AccountOwnerType>

Returns

Promise<null | AccountOwnerType>

Defined in

core/auth/auth-provider.interface.ts:50


getProviderToken

getProviderToken(): Promise<null | string>

Returns

Promise<null | string>

Defined in

core/auth/auth-provider.interface.ts:51

Properties

authType

Readonly authType: AccountOwnerType

Authentication type

Inherited from

TokenStorageProvider.authType

Defined in

core/auth/auth-provider.interface.ts:14