Homebridge icon

Homebridge

Interact with Homebridge API

Actions77

Overview

This node integrates with the Homebridge API, specifically allowing management of user accounts. The "Update User" operation lets you modify details of an existing user in the Homebridge system. This is useful for automating user management tasks such as changing usernames, updating display names, or toggling administrative privileges without manual intervention.

Practical examples include:

  • Automatically updating user information when syncing with an external user directory.
  • Changing user roles programmatically based on business logic.
  • Correcting user details in bulk via workflows.

Properties

Name Meaning
Access Token An access token obtained from a prior login operation or entered manually to authenticate.
User ID The unique identifier of the user to update (required).
Name The new full name of the user (required).
Username The new username for the user (required).
Admin Boolean flag indicating whether the user has administrative privileges (true/false).

Output

The node outputs JSON data representing the updated user object returned by the Homebridge API after the update operation. This typically includes the user's ID, name, username, admin status, and possibly other metadata fields as provided by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Homebridge API server.
  • Needs an API authentication token (access token) which can be obtained from a login operation or entered manually.
  • The node expects the Homebridge API base URL to be configured in credentials.

Troubleshooting

  • Invalid or missing access token: Ensure the access token is valid and not expired. Re-authenticate if necessary.
  • User ID not found: Verify that the User ID exists in the Homebridge system before attempting to update.
  • Required fields missing: Name and Username are mandatory; ensure they are provided.
  • API connectivity issues: Check network connectivity and correct API base URL configuration.
  • Permission errors: The access token must have sufficient permissions to update user details.

Links and References

Discussion