Steuerboard icon

Steuerboard

Consume the Steuerboard API

Overview

This node integrates with the Steuerboard API to manage workspace members. Specifically, the "Delete" operation under the "Workspace Member" resource removes a user from a specified workspace within a client context. This is useful in scenarios where you need to revoke access or remove users who no longer should be part of a workspace, such as offboarding employees or managing team memberships dynamically.

Practical examples:

  • Automatically removing a user from a project workspace when their contract ends.
  • Cleaning up workspace memberships based on external HR system changes.
  • Managing user access rights programmatically during workflow automation.

Properties

Name Meaning
Client ID The unique identifier of the client owning the workspace.
Workspace ID The unique identifier of the workspace from which the user will be removed.
User ID The identifier of the user to be removed from the workspace.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this would include confirmation of successful removal or details about any error encountered. There is no indication that binary data is output by this node.

Example output JSON might look like:

{
  "success": true,
  "message": "User removed from workspace successfully"
}

Dependencies

  • Requires an API key credential for authenticating with the Steuerboard API.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on the Steuerboard API being accessible and the provided IDs (client, workspace, user) being valid.

Troubleshooting

  • Invalid IDs: If the client ID, workspace ID, or user ID are incorrect or do not exist, the API will likely return an error indicating the resource was not found. Verify all IDs before running the node.
  • Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions to modify workspace memberships.
  • Network issues: Connectivity problems to the Steuerboard API endpoint can cause timeouts or failures.
  • Permission denied: The authenticated user may lack rights to remove members from the specified workspace; check API permissions.

Common error messages:

  • "User not found": The user ID does not correspond to a member of the workspace.
  • "Workspace not found": The workspace ID is invalid or inaccessible.
  • "Unauthorized" or "Forbidden": Authentication failed or insufficient permissions.

Resolving these typically involves verifying input parameters, checking API credentials, and ensuring proper permissions.

Links and References

  • Steuerboard API documentation (refer to official API docs for detailed endpoints and error codes)
  • n8n documentation on creating and using API credentials
  • General REST API best practices for handling authentication and error responses

Discussion