Payload CMS

Interact with Payload CMS collections and globals
Join our community

Actions18

Overview

This node interacts with the Payload CMS Auth resource to perform user authentication-related operations, specifically the 'Unlock' operation in this context. It allows unlocking a user account in an auth-enabled collection by sending a POST request with the user's email. This is useful in scenarios where user accounts are locked due to security policies or multiple failed login attempts, and an administrator or automated workflow needs to unlock the account programmatically.

Use Case Examples

  1. Unlock a user account in the 'users' auth collection by providing the user's email address.
  2. Automate unlocking of user accounts after verification or support intervention.

Properties

Name Meaning
Auth Collection Specifies the auth-enabled collection to operate on, such as 'users' or other custom auth collections.

Output

JSON

  • json - The JSON response from the Payload CMS API containing the result of the unlock operation, typically including user data or status information.

Dependencies

  • Requires an API key credential for Payload CMS API authentication.

Troubleshooting

  • Common issues include authentication failures due to invalid or expired API credentials. Ensure the API key credential is valid and has appropriate permissions.
  • Errors may occur if the specified auth collection does not exist or is not auth-enabled. Verify the collection name is correct and accessible.
  • Malformed or missing email parameter will cause the unlock operation to fail. Ensure the email is provided and correctly formatted.

Links

Discussion