Actions31
Overview
This node integrates with the Steuerboard API to manage users, specifically allowing you to invite new users by sending them an invitation email. The "User Invite" operation is useful in scenarios where you want to programmatically add users to your system or platform and assign them specific roles and workspace access immediately upon invitation.
Practical examples include:
- Automatically inviting new team members to a project management tool.
- Adding clients or collaborators to a shared workspace with predefined roles.
- Streamlining onboarding by specifying which workspaces the user should join right away.
Properties
| Name | Meaning |
|---|---|
| Client ID | The unique identifier of the client for whom the user is being invited. |
| The email address that will receive the invitation to join the platform. | |
| Role | The role assigned to the invited user. Options: Admin (full access), User (limited access). |
| Workspace IDs | Optional comma-separated list of workspace IDs that the invited user should join immediately. |
Output
The node outputs JSON data representing the result of the invitation request. This typically includes details about the invited user such as their email, assigned role, and any confirmation or status information returned by the Steuerboard API.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the Steuerboard API.
- Needs an API authentication token configured in n8n credentials to authorize requests.
- The base URL for the API must be set in the credential configuration.
Troubleshooting
- Invalid or missing Client ID: Ensure the Client ID is correct and corresponds to an existing client in the Steuerboard system.
- Email format errors: Verify the email address is valid and properly formatted.
- Role assignment issues: Confirm the role value is either "admin" or "user".
- Workspace IDs parsing: If providing workspace IDs, ensure they are comma-separated without extra spaces or invalid characters.
- API authentication failures: Check that the API key/token is correctly set up and has sufficient permissions.
- Network or connectivity problems: Verify network access to the Steuerboard API endpoint.
Common error messages usually relate to validation failures or authorization errors and can be resolved by correcting input values or updating credentials.
Links and References
- Steuerboard API documentation (refer to official API docs for detailed endpoints and payloads)
- n8n documentation on creating and using API credentials
- General best practices for email invitations and role management in SaaS platforms