Actions118
- Item Actions
- Activity Actions
- Asset Actions
- Authentication Actions
- Collection Actions
- Extension Actions
- Field Actions
- File Actions
- Folder Actions
- Permission Actions
- Preset Actions
- Relation Actions
- Revision Actions
- Role Actions
- Server Actions
- Setting Actions
- User Actions
- Utility Actions
- Webhook Actions
Authentication → Request Password Reset
AI-generatedOverview
This node handles the 'Request Password Reset' operation for the Authentication resource in Directus. It allows users to request a password reset email to be sent to a specified email address. This is useful in scenarios where users have forgotten their passwords and need to regain access to their accounts by receiving a reset link via email.
Use Case Examples
- A user enters their email address to receive a password reset link.
- An admin triggers a password reset request for a user who cannot access their account.
Properties
| Name | Meaning |
|---|---|
| The email address of the user for whom the password reset is being requested. This is a required field. | |
| Additional Fields | Optional additional settings for the password reset request, including a custom reset URL that the reset link will lead to. The reset token will be passed as a parameter in this URL. |
Output
JSON
success- Indicates whether the password reset request was successfully processed.message- Additional information or confirmation message related to the password reset request.
Dependencies
- Requires an API key credential or authentication token to interact with the Directus API.
Troubleshooting
- Ensure the email address provided is valid and registered in the system to avoid errors.
- If using a custom reset URL, verify that the PASSWORD_RESET_URL_ALLOW_LIST environment variable is properly configured to allow the URL.
- Common errors may include invalid email format, unregistered email, or misconfiguration of environment variables for custom URLs.
Links
- Directus Environment Variables - Security - Documentation on configuring environment variables including PASSWORD_RESET_URL_ALLOW_LIST for enabling custom reset URLs.