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 / rest / passwordRequest

Function: passwordRequest() ​

passwordRequest<Schema>(email, reset_url?): RestCommand<void, Schema>

Defined in: rest/commands/auth/password-request.ts:12

Request a password reset email to be sent to the given user.

Type Parameters ​

• Schema

Parameters ​

email ​

string

Email address of the user you're requesting a password reset for.

reset_url? ​

string

Provide a custom reset url which the link in the email will lead to. The reset token will be passed as a parameter.

Returns ​

RestCommand<void, Schema>

Empty body.