BookStack

Consume BookStack API

Actions31

Book Actions
Page Actions
Chapter Actions
Shelf Actions
User Actions
Role Actions
Attachment Actions
Tag Actions

Overview

This node integrates with the BookStack API to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the User resource with the Update operation, it allows updating user details by sending a PUT request to the BookStack API endpoint corresponding to the user ID.

Common scenarios where this node is beneficial include automating user management tasks in BookStack, such as updating user information programmatically based on external data sources or workflows. For example, an organization could use this node to synchronize user details from an HR system into BookStack automatically.

Properties

Name	Meaning
ID	The unique identifier of the user to update. This is required to specify which user resource will be updated.

Note: Although only the ID property is explicitly defined in the provided input properties, the node's internal logic suggests that other fields like name, description, or similar might be supported depending on the resource and operation. However, for the User resource and Update operation, only ID is explicitly required here.

Output

The node outputs JSON data representing the updated user resource as returned by the BookStack API. The structure typically includes the user's updated attributes such as ID, name, email, roles, and other relevant user details.

No binary data output is indicated for this operation.

Dependencies

Requires an API key credential for authenticating with the BookStack API.
The base URL for the BookStack instance must be configured in the credentials.
The node sends HTTP requests to the BookStack API endpoints using the provided token-based authentication.

Troubleshooting

Missing or invalid ID: If the ID property is not provided or incorrect, the API call will fail with a 404 Not Found or similar error. Ensure the correct user ID is specified.
Authentication errors: If the API token or base URL is misconfigured, the node will return authentication errors. Verify the API credentials and endpoint URL.
API permission issues: The API token used must have sufficient permissions to update user resources; otherwise, the request will be denied.
Invalid payload: If additional fields are sent but do not conform to the API schema, the update may fail. Confirm that only valid fields are included.