Steuerboard icon

Steuerboard

Consume the Steuerboard API

Overview

This node integrates with the Steuerboard API to manage users within clients. Specifically, the "User" resource with the "Delete" operation allows you to remove a user from a specified client. This is useful in scenarios where you need to revoke access or clean up user assignments programmatically.

Practical examples include:

  • Automatically removing a user from a client when they leave an organization.
  • Managing user memberships dynamically based on external triggers or workflows.

Properties

Name Meaning
Client ID The ID of the client from which to remove the user.
User ID The ID of the user to be removed from the client.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the user was successfully removed from the client. The exact structure depends on the Steuerboard API response but generally includes status information and possibly details about the affected user or client.

No binary data output is expected for this operation.

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.
  • Network connectivity to the Steuerboard API endpoint.

Troubleshooting

  • Missing or invalid Client ID/User ID: Ensure both IDs are provided and valid; otherwise, the API will reject the request.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • API endpoint unreachable: Check network connectivity and the correctness of the base URL.
  • User not found or already removed: The API may return an error if the user does not exist under the specified client; verify the IDs beforehand.

Links and References

  • Steuerboard API documentation (refer to your internal or public API docs for detailed endpoints and responses).

Discussion