Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the bundled source). Specifically, for the User resource and the Update Bound User Details operation, it updates details of a bound user within a specified company and hub context. This includes modifying notification settings, permissions, group permissions, and additional user-related fields.

Typical use cases include:

  • Updating user notification preferences for alarms, malfunctions, armings, and events.
  • Adjusting user permissions related to system control, device management, and privacy settings.
  • Managing group-specific permissions for users.
  • Setting roles and images associated with the bound user.

Practical example: An administrator wants to update a user's notification channels to receive SMS alerts for alarms and enable specific permissions like adding or deleting users. This node facilitates such updates programmatically via the Ajax API.

Properties

Name Meaning
Company Id The unique identifier of the company to which the bound user belongs.
Hub Id The unique identifier of the hub where the bound user is registered.
Bound User Id The unique identifier of the bound user whose details are being updated.
Notification Settings Configuration of notification channels for different event types:
- Alarms: PUSH, SMS, CALL
- Malfunctions: PUSH, SMS
- Armings: PUSH, SMS
- Events: PUSH, SMS
Permissions List of permissions granted to the user, including but not limited to:
USER_ADD, USER_DELETE, USER_ROLE_UPDATE, USER_PERMISSIONS_UPDATE, USER_NOTIFICATION_SETTINGS_UPDATE, ROOM_ADD_UPDATE_DELETE, DEVICE_ADD_UPDATE_DELETE, CAMERA_ADD_UPDATE_DELETE, GROUP_ADD_UPDATE_DELETE, EVENTS_GET, GET, ARM, DISARM, NIGHT_MODE, PANIC, HUB_NET_SETTINGS_UPDATE, HUB_OTHER_SETTINGS_UPDATE, STATE_COMMANDS, FIRMWARE_COMMANDS, SCENARIO, CHIMES_UPDATE, PRIVACY_ACCESS_SETTINGS, MUTE_FIRE_PROTECT, BLE_ACCESS
Groups Permissions Multiple entries specifying group IDs and corresponding permissions (ARM, DISARM) assigned to the user for each group.
Restore After Alarm Condition Permissions Permissions related to restoring after specific alarm conditions, including CONFIRMED_ALARMS, CONFIRMED_HU_ALARMS, UNCONFIRMED_ALARMS, UNCONFIRMED_HU_ALARMS, TAMPER_ACTIVATION, EXTERNAL_POWER_ACTIVATION, ATS_ACTIVATION, OTHER_FAULT_ACTIVATION.
Additional Fields Optional extra fields:
- Image Urls: URLs for small, medium, and big images.
- Hub Binding Role: Role of the user binding in the hub (MASTER, USER, PRO).

Output

The node outputs JSON data representing the result of the update operation on the bound user. This typically includes confirmation of the updated user details as returned by the Ajax API. The exact structure depends on the API response but generally reflects the new state of the bound user's properties after the update.

If the node supports binary data output, it would relate to image URLs or other media associated with the user, but this is not explicitly detailed in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the Ajax API service endpoint to perform user updates.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
  • No additional environment variables or external services are explicitly required beyond the API credential.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Invalid identifiers: Errors may occur if companyId, hubId, or boundUserId are incorrect or do not exist in the Ajax system.
  • Permission issues: Attempting to assign unsupported permissions or invalid combinations may cause API rejections.
  • Notification settings format: Providing invalid notification channel values outside the allowed options (PUSH, SMS, CALL) can lead to errors.
  • Network or API downtime: Connectivity issues with the Ajax API will prevent successful execution.

To resolve these:

  • Double-check all input IDs and ensure they correspond to existing entities.
  • Validate permission and notification settings against allowed options.
  • Verify API credentials and their scopes.
  • Monitor network connectivity and API status.

Links and References

Note: The summary is based solely on static analysis of the provided source and property definitions without runtime execution or dynamic import resolution.

Discussion