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 default team with admin rights when they join an 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 unique ID.
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. There is no indication that binary data is output by this node.

Dependencies

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

Troubleshooting

  • Invalid Team ID or Name: If the team identifier is incorrect or does not exist, the API will likely return an error. Verify the team exists and the ID or name is correct.
  • User Not Found: Adding a user with a username that does not exist in Vikunja will fail. Ensure the username is valid.
  • Insufficient Permissions: If the API key used lacks permissions to modify team memberships, the request will be denied. Check API key scopes and permissions.
  • Network Issues: Connectivity problems to the Vikunja server will cause failures. Confirm network access and API endpoint availability.
  • Missing Required Fields: Omitting required properties like team or username will cause validation errors.

Links and References

Discussion