Skip to content
On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / auth / AuthenticationClient

Interface: AuthenticationClient<_Schema> ​

Defined in: auth/types.ts:31

Type Parameters ​

• _Schema

Methods ​

getToken() ​

getToken(): Promise<null | string>

Defined in: auth/types.ts:38

Returns ​

Promise<null | string>


login() ​

login(email, password, options?): Promise<AuthenticationData>

Defined in: auth/types.ts:32

Parameters ​

email ​

string

password ​

string

options? ​

LoginOptions

Returns ​

Promise<AuthenticationData>


logout() ​

logout(): Promise<void>

Defined in: auth/types.ts:34

Returns ​

Promise<void>


refresh() ​

refresh(): Promise<AuthenticationData>

Defined in: auth/types.ts:33

Returns ​

Promise<AuthenticationData>


setToken() ​

setToken(access_token): Promise<unknown>

Defined in: auth/types.ts:39

Parameters ​

access_token ​

null | string

Returns ​

Promise<unknown>


stopRefreshing() ​

stopRefreshing(): void

Defined in: auth/types.ts:36

Returns ​

void