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 in the bundled source). It supports multiple resources and operations, including managing access codes. Specifically, for the "Access Code" resource and the "Update Access Code Password" operation, it allows users to update the password of an existing access code by providing necessary identifiers and a new password.

Common scenarios where this node is beneficial include:

  • Security management workflows where access code credentials need to be updated programmatically.
  • Automating user or hub access control changes without manual intervention.
  • Integrating Ajax security system management into broader automation pipelines.

Example use case: Automatically updating the access code password for a specific user and hub when a security policy requires periodic password rotation.

Properties

Name Meaning
User Id Identifier of the user associated with the access code.
Hub Id Identifier of the hub where the access code is registered.
Access Code Id Identifier of the specific access code to update.
New Password The new password for the access code; must be a 4-6 digit numeric code.

Output

The node outputs JSON data representing the result of the update operation. This typically includes confirmation of the updated access code details or status information returned from the Ajax API. The exact structure depends on the API response but generally confirms success or failure of the password update.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the Ajax API being accessible and properly configured.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution.

Troubleshooting

  • Invalid Credentials: If the API key is missing or invalid, the node will fail authentication. Ensure the correct API key credential is configured.
  • Missing Required Parameters: All properties (User Id, Hub Id, Access Code Id, New Password) are required. Omitting any will cause errors.
  • Password Format Errors: The new password must be 4-6 digits. Providing an invalid format may cause the API to reject the request.
  • API Connectivity Issues: Network problems or incorrect endpoint configuration can lead to timeouts or connection errors.
  • Access Code Not Found: If the specified access code ID does not exist under the given user and hub, the API will return an error.

To resolve these issues, verify all input parameters, ensure valid credentials, and confirm network connectivity to the Ajax API.

Links and References

Discussion