Actions77
- Accessory Actions
- Authentication Actions
- Backup & Restore Actions
- Config Editor Actions
- Platform Tool Actions
- Plugin Actions
- Server Actions
- Restart Server
- Restart Child Bridge
- Stop Child Bridge
- Start Child Bridge
- Get Pairing Info
- Reset Homebridge Accessory
- Reset Cached Accessories
- Get Cached Accessories
- Delete Cached Accessories
- Delete Cached Accessory
- Get Device Pairings
- Get Device Pairing
- Delete Device Pairing
- Get Unused Port
- Get Network Interfaces
- Get Bridge Network Interfaces
- Set Bridge Network Interfaces
- Setup Wizard Actions
- Status Actions
- User Actions
Overview
This node integrates with the Homebridge API, allowing users to manage various aspects of a Homebridge server environment. Specifically, for the "User" resource and the "List Users" operation, it retrieves a list of user accounts registered in the Homebridge system. This is useful for administrators who want to view or audit existing users, manage permissions, or synchronize user data with other systems.
Practical examples include:
- Fetching all users to display in an admin dashboard.
- Exporting user lists for backup or migration purposes.
- Automating user management workflows by integrating with other tools.
Properties
| Name | Meaning |
|---|---|
| Access Token | Access token obtained from a prior login operation or entered manually to authenticate requests to the Homebridge API. |
Output
The node outputs JSON data representing the list of users retrieved from the Homebridge API. Each item in the output corresponds to a user object containing details such as username, roles, and other relevant user information managed by Homebridge.
If the node supports binary data output (not indicated here), it would typically represent files or media related to users, but this operation focuses on JSON user data only.
Dependencies
- Requires an active connection to a Homebridge server API.
- Needs an access token credential for authentication, which can be provided either by connecting a Login node or manually entering the token.
- The base URL for the Homebridge API must be configured in the node credentials or environment.
Troubleshooting
- Invalid or missing access token: The node will fail to authenticate if the access token is incorrect or expired. Ensure the token is valid and refreshed if necessary.
- API connectivity issues: Network problems or incorrect server URLs can cause request failures. Verify the Homebridge server URL and network accessibility.
- Permission errors: If the token lacks sufficient privileges, the API may reject the request. Confirm that the token has rights to list users.
- Empty user list: Could indicate no users exist or a filtering issue; verify the Homebridge server state.
Links and References
- Homebridge API Documentation (for detailed API endpoints and user management)
- Homebridge Official Website