Payload CMS

Interact with Payload CMS collections and globals
Join our community

Actions18

Overview

This node interacts with Payload CMS to perform authentication-related operations such as user login. Specifically, the 'Auth - Login' operation allows users to authenticate by providing their email and password against a specified auth-enabled collection in Payload CMS. This is useful for workflows that require user authentication, session management, or integration with Payload CMS user data.

Use Case Examples

  1. Logging in a user to verify credentials and obtain an authentication token for subsequent API requests.
  2. Automating user authentication in a workflow that requires access to protected Payload CMS resources.

Properties

Name Meaning
Auth Collection The auth-enabled collection in Payload CMS to authenticate against, e.g., 'users'.
Email The email address of the user attempting to log in.
Password The password of the user attempting to log in.
Additional Options Optional parameters to customize the request such as depth of relationship population, pagination, sorting, filtering, field selection, and locale.

Output

JSON

  • json - The JSON response from Payload CMS containing authentication result data such as the authentication token and user information.

Dependencies

  • Requires an API key credential for Payload CMS with base URL and optional API prefix.

Troubleshooting

  • Authentication failures due to incorrect email or password will throw an error 'Authentication failed'. Verify credentials are correct.
  • Network or connectivity issues to the Payload CMS instance may cause request failures. Ensure the base URL is accessible.
  • Invalid JSON in 'Where' clause or other JSON fields in additional options may cause parsing errors. Ensure valid JSON format.

Links

Discussion