Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated by the bundled version file). It supports multiple resources and operations, including user-related actions such as resetting a bound user's specific keypad force disarm password. The node acts as a flexible interface to perform various Ajax API calls within an n8n workflow.

For the User resource and the Reset Bound User Specific Key Pad Force Disarm Password operation, this node allows you to reset the force disarm password associated with a specific bound user on a given hub. This can be useful in security management scenarios where a keypad's disarm password needs to be updated or cleared for a particular user, for example, after a security breach or when reassigning access rights.

Practical Example

  • Resetting the force disarm password for a user who lost their keypad password.
  • Managing user access control by programmatically updating keypad credentials across hubs.
  • Automating security maintenance tasks in large installations with multiple users and hubs.

Properties

Name Meaning
User Id The unique identifier of the user whose keypad force disarm password is to be reset.
Hub Id The unique identifier of the hub where the bound user and keypad are registered.
Bound User Id The unique identifier of the bound user whose specific keypad force disarm password will be reset.

These properties are required inputs to specify exactly which user's keypad password should be reset within which hub context.

Output

The node outputs JSON data representing the result of the reset operation. Typically, this would include confirmation of success or failure, status codes, and possibly updated user or keypad information reflecting the reset state.

If the operation involves binary data (not indicated here), it would represent files or media related to the user or device states, but for this operation, output is expected to be purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the @digital-boss/n8n-designpatterns package for response-operation resolution and execution logic.
  • Uses internal backend modules for HTTP client communication and state management.
  • The node must be configured with valid credentials and network access to the Ajax API endpoint.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly set up and has sufficient permissions.
  • Invalid IDs: Errors may occur if userId, hubId, or boundUserId do not correspond to existing entities in the Ajax system. Verify these IDs before running the node.
  • Network issues: Timeouts or connection failures indicate network problems or incorrect API endpoint configuration.
  • Operation not supported: If the operation or resource is misspelled or unsupported, the node may throw an error indicating unknown operation/resource.

To resolve errors:

  • Double-check all input property values.
  • Confirm API credentials and permissions.
  • Review API documentation for any changes in required parameters or endpoint behavior.

Links and References

Discussion