Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It provides a flexible interface to perform various operations on multiple resources related to an Ajax system, such as users, hubs, devices, and surveillance cameras.

The particular operation you asked about — Update Permission On Behalf Of UserId For CompanyId On Hub For Surveillance Cameras — allows updating access permissions for a user regarding surveillance camera devices connected to a specific hub within a company. This is useful in scenarios where an administrator or automated workflow needs to modify user permissions dynamically, for example:

  • Granting or revoking a user's ability to view or control surveillance cameras in a certain hub.
  • Automating permission updates when employees change roles or locations.
  • Managing access rights centrally for security compliance.

Properties

Name Meaning
User Id The unique identifier of the user whose permissions are being updated.
Hub Id The unique identifier of the hub where the surveillance cameras are located.
Company Id The unique identifier of the company that owns the hub and devices.
Availability Condition Defines whether the user’s access to the devices is always available or never available. Options: NEVER_AVAILABLE, ALWAYS_AVAILABLE.
Devices A collection of device entries specifying which devices' permissions to update. Each device includes:
- Device Id: Identifier of the device.
- Object Type: Type of the device; currently supports STREAMING_CAMERA.

Output

The node outputs JSON data representing the result of the permission update operation. While the exact structure is not explicitly shown in the provided source, it typically includes confirmation of success or failure, updated permission details, or error messages if applicable.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service to perform permission updates.
  • Uses internal helper classes for HTTP communication, state management, and operation execution.
  • Must be configured with valid credentials and network access to the Ajax API endpoint.

Troubleshooting

  • Authentication errors: If the API key or authentication token is missing or invalid, the node will fail to connect. Ensure the correct API credentials are set up in n8n.
  • Invalid IDs: Providing incorrect or non-existent User Id, Hub Id, Company Id, or Device Ids will likely cause errors or no effect. Verify all identifiers before running.
  • Permission conflicts: Attempting to update permissions without sufficient rights may result in authorization errors from the API.
  • Empty or malformed device list: The devices property must include at least one device with a valid device ID and object type; otherwise, the operation may fail.
  • Network issues: Connectivity problems to the Ajax API endpoint can cause timeouts or failures.

Links and References

If you need further details on other operations or resources, feel free to ask!

Discussion