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

Type alias: LoginOptions

LoginOptions: Object

Type declaration


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.


optional otp: string

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


optional provider: string

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