Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with an Ajax API (version indicated in the code). It supports multiple resources and operations, including user management tasks such as unbinding a user from a hub. The node acts as a flexible interface to perform various backend operations by sending HTTP requests through a custom HttpClient.

For the User - Unbind User From Hub operation specifically, the node removes the association between a specified user and a hub within the system. This can be useful in scenarios where a user should no longer have access or linkage to a particular hub, for example, when revoking permissions or managing user assignments dynamically.

Practical examples:

  • Removing a user's access to a physical security hub after they leave a department.
  • Disassociating a user from a hub before deleting or archiving their account.
  • Automating user-hub relationship updates in response to organizational changes.

Properties

Name Meaning
User Id The unique identifier of the user to unbind from the hub.
Hub Id The unique identifier of the hub from which the user will be unbound.
Bound User Id The identifier of the bound user entity that represents the current binding to the hub.

These properties are required inputs for the unbind operation and must be provided to correctly identify the user-hub relationship to remove.

Output

The node outputs JSON data representing the result of the unbind operation. While the exact structure is not explicitly detailed in the source snippet, typically it would include confirmation of success or failure, possibly with details about the updated user or hub state.

No binary data output is indicated or expected for this operation.

Dependencies

  • Requires an API key credential to authenticate with the Ajax API service.
  • Depends on the HttpClient class to send HTTP requests to the backend.
  • Uses internal modules for state management and operation resolution/execution.
  • The node expects the environment to have access to the Ajax API endpoint configured via credentials.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Incorrect IDs: Providing wrong or non-existent User Id, Hub Id, or Bound User Id will likely cause errors or no effect. Verify these identifiers before execution.
  • Network issues: Connectivity problems to the Ajax API endpoint will cause request failures.
  • Operation not supported: If the resource or operation names are misspelled or unsupported, the node may throw errors related to operation resolution.

Common error messages might include authentication failures, resource not found, or invalid parameters. To resolve, check credentials, input values, and network connectivity.

Links and References

Discussion