Overview

This node interacts with the Workboard API to perform various operations on different resources such as users, goals, teams, metrics, activities, workstreams, tags, datastreams, and webhooks. Specifically, for the User resource with the Deactivate operation, it deactivates a user by sending a PATCH request to the Workboard API with the user ID and optional additional fields. This node is useful for automating user management tasks within the Workboard platform, such as deactivating users when they leave an organization or need to be temporarily disabled.

Use Case Examples

1. Deactivate a user by providing their User ID and optional additional fields like notes or state.
2. Automate user lifecycle management by integrating this node into workflows that handle onboarding and offboarding.

Properties

Output

JSON

• success - Indicates whether the deactivation operation was successful.
• user_id - The ID of the user that was deactivated (if returned by the API).
• message - Any message returned by the API regarding the deactivation operation.

Dependencies

• Workboard API with JWT Bearer Token authentication

Troubleshooting

• Ensure the provided User ID is correct and exists in the Workboard system to avoid errors.
• Verify that the API credentials (JWT Bearer Token) are valid and have the necessary permissions to deactivate users.
• If the API returns an error, check the error message for details such as invalid parameters or insufficient permissions.
• Make sure the additional fields, if provided, are formatted correctly, especially JSON fields like tags and comments.

Links

• Workboard API Documentation - Official API documentation for Workboard, useful for understanding available endpoints and parameters.