Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

The "Update Bound User" operation in the User resource allows updating the settings and permissions of a user who is bound to a specific hub within the system. This node is useful for managing user access, notification preferences, and permissions dynamically via workflows.

Typical use cases include:

  • Modifying a user's notification channels (e.g., enabling push notifications or SMS alerts).
  • Adjusting user permissions related to device control, event viewing, or hub management.
  • Updating group-specific permissions for the user.
  • Changing the user's role binding to the hub or updating associated images.

For example, an administrator could automate updating a user's permissions after a role change or modify notification settings based on user preferences collected from another system.

Properties

Name Meaning
User Id The unique identifier of the user to update.
Hub Id The unique identifier of the hub to which the user is bound.
Bound User Id The identifier of the bound user entity that links the user to the hub.
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, DEVICE_ADD_UPDATE_DELETE, CAMERA_GET, ARM, DISARM, PANIC, SCENARIO, BLE_ACCESS, etc.
Groups Permissions A collection of group-specific permissions, each with:
- Group Id
- Group Permissions (ARM, DISARM)
Restore After Alarm Condition Permissions Permissions related to restoring states after alarm conditions, such as CONFIRMED_ALARMS, UNCONFIRMED_ALARMS, TAMPER_ACTIVATION, EXTERNAL_POWER_ACTIVATION, etc.
Additional Fields Optional extra fields:
- Image Urls (small, medium, big)
- Hub Binding Role (MASTER, USER, PRO)

Output

The node outputs JSON data representing the updated bound user object after applying the changes. This typically includes confirmation of the updated fields such as user identifiers, updated permissions, notification settings, and any additional metadata like image URLs or roles.

If the node supports binary data output, it would relate to image data or other media associated with the user, but this is not explicitly indicated here.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API service.
  • Depends on the external Ajax API backend to perform user updates.
  • The node uses internal HTTP client and state management utilities to interact with the API.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Invalid or missing user/hub/bound user IDs: Ensure all required IDs are correctly provided; otherwise, the API will reject the request.
  • Insufficient permissions: If the API key or authenticated user lacks rights to update users or hubs, the operation will fail.
  • Incorrect notification or permission values: Use only the allowed options for notification channels and permissions to avoid validation errors.
  • API connectivity issues: Network problems or incorrect API credentials can cause failures; verify credentials and network access.
  • Malformed additional fields: When providing image URLs or roles, ensure correct formatting to prevent rejection.

Common error messages might include authorization errors, validation errors for input fields, or network timeouts. Resolving these involves checking credentials, input correctness, and network status.

Links and References

Discussion