_authentication_.iauthentication.md

@directus/sdk-js

Globals / "Authentication" / IAuthentication /

Interface: IAuthentication

Hierarchy

• IAuthentication

Implemented by

• Authentication

Index

Properties

• refreshInterval

Methods

• login
• logout
• refresh
• refreshIfNeeded

Properties

Optional refreshInterval

• refreshInterval? : number

Defined in Authentication.ts:31

Methods

login

▸ login(credentials: ILoginCredentials, options?: ILoginOptions): Promise<IAuthenticateResponse>

Defined in Authentication.ts:32

Parameters:

Name	Type
credentials	ILoginCredentials
options?	ILoginOptions

Returns: Promise<IAuthenticateResponse>

---

logout

▸ logout(): Promise<ILogoutResponse>

Defined in Authentication.ts:33

Returns: Promise<ILogoutResponse>

---

refresh

▸ refresh(token: string): Promise<IRefreshTokenResponse>

Defined in Authentication.ts:35

Parameters:

Name	Type
token	string

Returns: Promise<IRefreshTokenResponse>

---

refreshIfNeeded

▸ refreshIfNeeded(): Promise<[boolean, Error]>

Defined in Authentication.ts:34

Returns: Promise<[boolean, Error]>