Directus

Consume Directus API

Actions100

Overview

The Authentication → Request Password Reset operation in this n8n node allows you to initiate a password reset process for a user in a Directus instance. By providing the user's email address, this operation triggers Directus to send a password reset email to the specified user. Optionally, you can specify a custom reset URL that will be used in the email.

Common scenarios:

Automating user support workflows where users request password resets.
Integrating with self-service portals or helpdesk systems to allow users to reset their passwords without manual admin intervention.

Practical example:
A user forgets their password and submits a reset request via your web portal. This node is triggered, sending a password reset email through Directus, optionally using a custom reset link.

Properties

Name	Type	Meaning
Email	String	Email address of the user you're requesting a reset for. This is required and identifies which user should receive the reset.
Additional Fields	Object	Optional collection of extra parameters. For this operation, it supports:
		- Reset URL (String): Custom URL for the reset link in the email. The reset token will be appended as a parameter.

Output

The output will be a JSON object containing the response from the Directus API after attempting to request a password reset. The structure typically includes a status or confirmation message, but the exact fields depend on the Directus API's response.

Example output:

{
  "json": {
    // Response data from Directus, e.g.,
    "message": "Password reset email sent"
  }
}

If an error occurs and "Continue On Fail" is enabled, the output will include:

{
  "json": {
    "error": "Error message here"
  }
}

Dependencies

Directus API: You must have access to a running Directus instance.
API Credentials: The node requires valid Directus API credentials configured in n8n.
Environment Variable (optional): If using a custom reset URL, ensure the PASSWORD_RESET_URL_ALLOW_LIST environment variable is set in Directus to permit your custom URLs. See Directus documentation.

Troubleshooting

Common issues:

Invalid Email: If the provided email does not exist in Directus, the API may return an error or silently succeed (depending on configuration).
Custom Reset URL Not Working: If you provide a custom reset URL but haven't configured PASSWORD_RESET_URL_ALLOW_LIST, Directus will reject the request.
Missing Credentials: If API credentials are missing or incorrect, authentication errors will occur.

Common error messages:

"Email is required": Ensure the Email property is filled.
"Reset URL not allowed": Add your custom URL to the PASSWORD_RESET_URL_ALLOW_LIST in Directus.
"Unauthorized": Check your API credentials in n8n.