Directus (flagbit) icon

Directus (flagbit)

Consume Directus API

Overview

This node handles authentication-related operations, specifically the "Request Password Reset" operation. It allows users to initiate a password reset process by providing an email address. This is useful in scenarios where a user has forgotten their password and needs to receive a reset link via email.

A practical example: An admin wants to trigger a password reset email for a user who cannot access their account. By providing the user's email, the node sends a reset request that results in the user receiving an email with a reset link.

Properties

Name Meaning
Email The email address of the user for whom the password reset is being requested.
Additional Fields Optional additional settings for the reset request. Currently supports:
- Reset URL: A custom URL that the reset link will direct to. The reset token will be appended as a parameter. Note that enabling this requires configuring an environment variable to allow the URL.

Output

The output contains JSON data representing the result of the password reset request. Typically, this includes confirmation that the reset email was sent or any error messages if the request failed.

No binary data output is expected from this operation.

Dependencies

  • Requires an API endpoint or service capable of handling password reset requests.
  • Needs proper configuration of environment variables, especially if using a custom reset URL (e.g., a whitelist environment variable to allow specific URLs).
  • Requires valid authentication credentials (such as an API key or token) to authorize the request.

Troubleshooting

  • Common issues:

    • Invalid or unregistered email address: The reset request may fail if the email does not exist in the system.
    • Misconfigured reset URL: If a custom reset URL is provided but not whitelisted in the environment variable, the reset link may not work.
    • Missing or invalid API credentials can cause authorization errors.
  • Error messages:

    • Errors indicating unauthorized access usually mean the API credentials are missing or incorrect.
    • Errors about invalid email typically mean the email is not found or improperly formatted.
    • Errors related to the reset URL often point to missing environment variable configuration.

To resolve these, verify the email address, ensure API credentials are correctly set up, and configure environment variables properly when using custom reset URLs.

Links and References

Discussion