Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to manage teams and their members. Specifically, the "Add a User" operation under the "Team" resource allows you to add a user to a specified team by providing the team's identifier and the user's username. You can also specify whether the added user should have admin privileges within that team.

Common scenarios for this node include automating team membership management in project or task management workflows, such as onboarding new users into specific teams or adjusting team roles programmatically.

Example use case: Automatically adding a newly created user to a project team with admin rights when they join your organization.

Properties

Name Meaning
Team Name or ID The target team to which the user will be added. You can select from a list of existing teams or provide the team's ID directly.
Username The username of the user to add to the team.
Is Admin Boolean flag indicating if the user should be granted admin privileges within the team.

Output

The node outputs JSON data representing the result of the API call to add the user to the team. This typically includes confirmation details such as the updated team membership status or the user’s role within the team.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Vikunja API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the Vikunja API must be set correctly in the credentials.

Troubleshooting

  • Invalid Team ID or Username: If the team ID or username does not exist, the API will return an error. Verify that the team and user exist before running the node.
  • Insufficient Permissions: Adding a user as an admin requires appropriate permissions. Ensure the API token has rights to modify team memberships.
  • Network Issues: Connection errors may occur if the API URL is incorrect or unreachable. Confirm the API endpoint and network connectivity.
  • Missing Required Fields: The node requires the team and username fields; missing these will cause validation errors.

Links and References

Discussion