[PERS SDK - v2.3.26](/sdk-reference/readme) / [Exports](/sdk-reference/modules) / DefaultAuthProvider

# Class: DefaultAuthProvider

Simple authentication provider with token storage

## Implements

- [`TokenStorageProvider`](/sdk-reference/interfaces/tokenstorageprovider)


## Table of contents

### Constructors

- [constructor](/sdk-reference/classes/defaultauthprovider#constructor)


### Methods

- [getToken](/sdk-reference/classes/defaultauthprovider#gettoken)
- [getAuthHeaders](/sdk-reference/classes/defaultauthprovider#getauthheaders)
- [getProjectKey](/sdk-reference/classes/defaultauthprovider#getprojectkey)
- [onAuthStatusChange](/sdk-reference/classes/defaultauthprovider#onauthstatuschange)
- [setAccessToken](/sdk-reference/classes/defaultauthprovider#setaccesstoken)
- [setRefreshToken](/sdk-reference/classes/defaultauthprovider#setrefreshtoken)
- [getRefreshToken](/sdk-reference/classes/defaultauthprovider#getrefreshtoken)
- [clearTokens](/sdk-reference/classes/defaultauthprovider#cleartokens)
- [setTokens](/sdk-reference/classes/defaultauthprovider#settokens)
- [hasValidToken](/sdk-reference/classes/defaultauthprovider#hasvalidtoken)
- [setAuthType](/sdk-reference/classes/defaultauthprovider#setauthtype)
- [getAuthType](/sdk-reference/classes/defaultauthprovider#getauthtype)
- [setProviderToken](/sdk-reference/classes/defaultauthprovider#setprovidertoken)
- [getProviderToken](/sdk-reference/classes/defaultauthprovider#getprovidertoken)


### Properties

- [authType](/sdk-reference/classes/defaultauthprovider#authtype)


## Constructors

### constructor

• **new DefaultAuthProvider**(`config?`): [`DefaultAuthProvider`](/sdk-reference/classes/defaultauthprovider)

#### Parameters

| Name | Type |
|  --- | --- |
| `config` | [`AuthConfig`](/sdk-reference/interfaces/authconfig) |


#### Returns

[`DefaultAuthProvider`](/sdk-reference/classes/defaultauthprovider)

#### Defined in

[core/auth/default-auth-provider.ts:23](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L23)

## Methods

### getToken

▸ **getToken**(): `Promise`<`null` | `string`>

Get current access token

#### Returns

`Promise`<`null` | `string`>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[getToken](/sdk-reference/interfaces/tokenstorageprovider#gettoken)

#### Defined in

[core/auth/default-auth-provider.ts:84](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L84)

### getAuthHeaders

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

Get derived authentication headers (e.g. DPoP)

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `token` | `null` | `string` | The current access token |
| `method?` | `string` | HTTP Method |
| `url?` | `string` | Request URL |


#### Returns

`Promise`<`Record`<`string`, `string`>>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[getAuthHeaders](/sdk-reference/interfaces/tokenstorageprovider#getauthheaders)

#### Defined in

[core/auth/default-auth-provider.ts:88](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L88)

### getProjectKey

▸ **getProjectKey**(): `Promise`<`null` | `string`>

Get project key for API requests

#### Returns

`Promise`<`null` | `string`>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[getProjectKey](/sdk-reference/interfaces/tokenstorageprovider#getprojectkey)

#### Defined in

[core/auth/default-auth-provider.ts:111](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L111)

### onAuthStatusChange

▸ **onAuthStatusChange**(`status`): `Promise`<`void`>

Handle authentication status changes

#### Parameters

| Name | Type |
|  --- | --- |
| `status` | [`AuthStatus`](/sdk-reference/enums/authstatus) |


#### Returns

`Promise`<`void`>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[onAuthStatusChange](/sdk-reference/interfaces/tokenstorageprovider#onauthstatuschange)

#### Defined in

[core/auth/default-auth-provider.ts:115](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L115)

### setAccessToken

▸ **setAccessToken**(`token`): `Promise`<`void`>

#### Parameters

| Name | Type |
|  --- | --- |
| `token` | `string` |


#### Returns

`Promise`<`void`>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[setAccessToken](/sdk-reference/interfaces/tokenstorageprovider#setaccesstoken)

#### Defined in

[core/auth/default-auth-provider.ts:137](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L137)

### setRefreshToken

▸ **setRefreshToken**(`token`): `Promise`<`void`>

#### Parameters

| Name | Type |
|  --- | --- |
| `token` | `string` |


#### Returns

`Promise`<`void`>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[setRefreshToken](/sdk-reference/interfaces/tokenstorageprovider#setrefreshtoken)

#### Defined in

[core/auth/default-auth-provider.ts:151](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L151)

### getRefreshToken

▸ **getRefreshToken**(): `Promise`<`null` | `string`>

#### Returns

`Promise`<`null` | `string`>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[getRefreshToken](/sdk-reference/interfaces/tokenstorageprovider#getrefreshtoken)

#### Defined in

[core/auth/default-auth-provider.ts:155](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L155)

### clearTokens

▸ **clearTokens**(): `Promise`<`void`>

#### Returns

`Promise`<`void`>

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[clearTokens](/sdk-reference/interfaces/tokenstorageprovider#cleartokens)

#### Defined in

[core/auth/default-auth-provider.ts:159](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L159)

### setTokens

▸ **setTokens**(`accessToken`, `refreshToken?`, `providerToken?`): `Promise`<`void`>

#### Parameters

| Name | Type |
|  --- | --- |
| `accessToken` | `string` |
| `refreshToken?` | `string` |
| `providerToken?` | `string` |


#### Returns

`Promise`<`void`>

#### Defined in

[core/auth/default-auth-provider.ts:168](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L168)

### hasValidToken

▸ **hasValidToken**(): `Promise`<`boolean`>

#### Returns

`Promise`<`boolean`>

#### Defined in

[core/auth/default-auth-provider.ts:174](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L174)

### setAuthType

▸ **setAuthType**(`_authType`): `Promise`<`void`>

#### Parameters

| Name | Type |
|  --- | --- |
| `_authType` | `AccountOwnerType` |


#### Returns

`Promise`<`void`>

#### Defined in

[core/auth/default-auth-provider.ts:178](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L178)

### getAuthType

▸ **getAuthType**(): `Promise`<`null` | `AccountOwnerType`>

#### Returns

`Promise`<`null` | `AccountOwnerType`>

#### Defined in

[core/auth/default-auth-provider.ts:183](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L183)

### setProviderToken

▸ **setProviderToken**(`token`): `Promise`<`void`>

Store the provider token (Firebase JWT, Auth0 token, etc.)
Used for session recovery when refresh tokens expire.

NOTE: This is called AUTOMATICALLY by loginWithToken(), so you typically
don't need to call this manually. The only reason to call this is if:

1. Your auth provider (Firebase, Auth0) refreshes tokens in the background
2. You want to proactively update the stored token for better recovery chances


The stored provider token is used as a fallback when:

- PERS refresh token expires (e.g., after 30 days of inactivity)
- SDK attempts recovery using the stored provider token
- If provider token is still valid → session recovered automatically
- If provider token is also expired → user must re-authenticate


#### Parameters

| Name | Type |
|  --- | --- |
| `token` | `string` |


#### Returns

`Promise`<`void`>

**`Example`**

```ts
// Optional: Update stored token when Firebase refreshes it
firebase.auth().onIdTokenChanged(async (user) => {
  if (user) {
    const freshToken = await user.getIdToken();
    await sdk.auth.setProviderToken(freshToken);
  }
});
```

#### Defined in

[core/auth/default-auth-provider.ts:245](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L245)

### getProviderToken

▸ **getProviderToken**(): `Promise`<`null` | `string`>

Get the stored provider token (Firebase JWT, Auth0 token, etc.)
Used internally for session recovery when refresh tokens expire.

#### Returns

`Promise`<`null` | `string`>

#### Defined in

[core/auth/default-auth-provider.ts:253](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L253)

## Properties

### authType

• `Readonly` **authType**: `AccountOwnerType`

Authentication type

#### Implementation of

[TokenStorageProvider](/sdk-reference/interfaces/tokenstorageprovider).[authType](/sdk-reference/interfaces/tokenstorageprovider#authtype)

#### Defined in

[core/auth/default-auth-provider.ts:19](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/auth/default-auth-provider.ts#L19)