Appearance

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

Function: passwordReset() ​

passwordReset<Schema>(token, password): RestCommand<void, Schema>

The request a password reset endpoint sends an email with a link to the admin app (or a custom route) which in turn uses this endpoint to allow the user to reset their password.

Type parameters ​

• Schema extends object

Parameters ​

• token: string

Password reset token, as provided in the email sent by the request endpoint.

• password: string

New password for the user.

Returns ​

RestCommand<void, Schema>

Empty body.

Source ​

rest/commands/auth/password-reset.ts:12