---
url: /docs/api/core/type-aliases/AuthProvider.md
---
[**@kaiord/core**](../README.md)

***

[@kaiord/core](../README.md) / AuthProvider

# Type Alias: AuthProvider

> **AuthProvider** = `object`

Defined in: [packages/core/src/ports/auth-provider.ts:9](https://github.com/pablo-albaladejo/kaiord/blob/3eacbe62ef72342d970523967cc5155b5935bb85/packages/core/src/ports/auth-provider.ts#L9)

Port for authentication against a remote service.

## Properties

### export_tokens

> **export_tokens**: () => `Promise`<[`TokenData`](TokenData.md)>

Defined in: [packages/core/src/ports/auth-provider.ts:12](https://github.com/pablo-albaladejo/kaiord/blob/3eacbe62ef72342d970523967cc5155b5935bb85/packages/core/src/ports/auth-provider.ts#L12)

#### Returns

`Promise`<[`TokenData`](TokenData.md)>

***

### is_authenticated

> **is_authenticated**: () => `boolean`

Defined in: [packages/core/src/ports/auth-provider.ts:11](https://github.com/pablo-albaladejo/kaiord/blob/3eacbe62ef72342d970523967cc5155b5935bb85/packages/core/src/ports/auth-provider.ts#L11)

#### Returns

`boolean`

***

### login

> **login**: (`username`, `password`) => `Promise`<`void`>

Defined in: [packages/core/src/ports/auth-provider.ts:10](https://github.com/pablo-albaladejo/kaiord/blob/3eacbe62ef72342d970523967cc5155b5935bb85/packages/core/src/ports/auth-provider.ts#L10)

#### Parameters

##### username

`string`

##### password

`string`

#### Returns

`Promise`<`void`>

***

### logout

> **logout**: () => `Promise`<`void`>

Defined in: [packages/core/src/ports/auth-provider.ts:14](https://github.com/pablo-albaladejo/kaiord/blob/3eacbe62ef72342d970523967cc5155b5935bb85/packages/core/src/ports/auth-provider.ts#L14)

#### Returns

`Promise`<`void`>

***

### restore_tokens

> **restore_tokens**: (`tokens`) => `Promise`<`void`>

Defined in: [packages/core/src/ports/auth-provider.ts:13](https://github.com/pablo-albaladejo/kaiord/blob/3eacbe62ef72342d970523967cc5155b5935bb85/packages/core/src/ports/auth-provider.ts#L13)

#### Parameters

##### tokens

[`TokenData`](TokenData.md)

#### Returns

`Promise`<`void`>