Directus / @directus/sdk / rest / login

Function: login() ​

login<Schema>(email, password, options): RestCommand<AuthenticationData, Schema>

Defined in: rest/commands/auth/login.ts:15

Authenticate as a user.

Type Parameters ​

• Schema

Parameters ​

email ​

string

Email address of the user.

password ​

string

Password of the user.

options ​

LoginOptions = {}

Optional login settings.

Returns ​

RestCommand<AuthenticationData, Schema>

Authentication data.