Homebridge icon

Homebridge

Interact with Homebridge API

Actions77

Overview

This node integrates with the Homebridge API to manage user accounts, specifically allowing the creation of new users. It is useful in scenarios where you want to programmatically add users to a Homebridge server, for example, automating user management in smart home setups or integrating user provisioning into larger workflows.

A practical example would be creating a new user with specific credentials and admin rights after a signup event in another system, enabling seamless access control within Homebridge.

Properties

Name Meaning
Access Token An access token obtained from a prior login operation or entered manually for authentication.
Name The full name of the user to create.
Username The username for the new user account.
Password The password for the new user account.
Admin Boolean flag indicating if the user should have administrative privileges (true/false).

Output

The node outputs JSON data representing the response from the Homebridge API after attempting to create the user. This typically includes details about the newly created user such as their ID, username, name, and admin status.

No binary data output is involved.

Dependencies

  • Requires an active connection to a Homebridge server.
  • Needs an API key or access token credential for authentication.
  • The base URL of the Homebridge server must be configured in the node's credentials.

Troubleshooting

  • Invalid or missing access token: Ensure the access token is correctly provided either via a previous login node or manually.
  • Required fields missing: Name, Username, and Password are mandatory; omitting them will cause errors.
  • Permission errors: If the access token does not have sufficient rights, user creation will fail.
  • API connectivity issues: Verify the Homebridge server URL and network connectivity.

Links and References

Discussion