Skip to content
On this page

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>

Type parameters

_Schema extends object

Methods

getToken()

getToken(): Promise<null | string>

Returns

Promise<null | string>

Source

auth/types.ts:29


login()

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

Parameters

email: string

password: string

options?: LoginOptions

Returns

Promise<AuthenticationData>

Source

auth/types.ts:25


logout()

logout(): Promise<void>

Returns

Promise<void>

Source

auth/types.ts:27


refresh()

refresh(): Promise<AuthenticationData>

Returns

Promise<AuthenticationData>

Source

auth/types.ts:26


setToken()

setToken(access_token): void

Parameters

access_token: null | string

Returns

void

Source

auth/types.ts:30