Appearance

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 / LoginOptions

Type Alias: LoginOptions ​

LoginOptions: object

Type declaration ​

mode? ​

optional mode: AuthenticationMode

Whether to retrieve the refresh token in the JSON response, or in a httpOnly cookie. One of json, cookie or session. Defaults to cookie.

otp? ​

optional otp: string

The user's one-time-password (if MFA is enabled).

provider? ​

optional provider: string

Use a specific authentication provider (does not work for SSO that relies on browser redirects).

Defined in ​

auth/types.ts:3