Payload CMS

Interact with Payload CMS collections and globals
Join our community

Actions18

Overview

This node interacts with Payload CMS to perform various operations on collections, globals, and authentication-related actions. Specifically, for the 'Auth' resource with the 'Refresh Token' operation, it sends a POST request to refresh the authentication token for a specified auth-enabled collection. This is useful in scenarios where a user's session token needs to be renewed without requiring them to log in again, such as maintaining session continuity in web or mobile applications.

Use Case Examples

  1. Refreshing a user's authentication token to maintain session without re-login.
  2. Automating token refresh in workflows that require continuous authenticated access to Payload CMS.

Properties

Name Meaning
Auth Collection Specifies the auth-enabled collection to operate on, e.g., users or admins.
Additional Options Optional parameters to customize the request, including depth of relationship population, pagination (limit and page), sorting, filtering (where clause), field selection, and locale for localized content.

Output

JSON

  • json - The response data from the Payload CMS API, typically containing the refreshed authentication token and related information.

Dependencies

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

Troubleshooting

  • Authentication failures due to invalid or expired credentials. Ensure the API key and credentials are correct and have not expired.
  • Errors parsing JSON in the 'Where' clause if the input is malformed. Validate JSON format before input.
  • Network or connectivity issues with the Payload CMS instance can cause request failures. Verify the base URL and network access.
  • If the refresh token endpoint returns no token, check the Payload CMS server logs and configuration for authentication settings.

Links

Discussion