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, optionally granting them admin privileges within that team.

Common scenarios for this node include:

  • Automating team membership management by adding users to teams based on external triggers.
  • Managing user roles within teams programmatically, such as promoting a user to an admin when added.
  • Integrating Vikunja team management into broader workflows, e.g., onboarding processes where new employees are automatically added to relevant teams.

Practical example:

  • When a new employee joins, use this node to add their username to the appropriate Vikunja team and set whether they should have admin rights.

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 specify the team's ID directly.
Username The username of the user to add to the team.
Is Admin Boolean flag indicating if the added user should have admin privileges in the team. Options: true (admin) or false (regular member).

Output

The node outputs JSON data representing the result of the API call to add a user to a team. This typically includes confirmation details about the updated team membership or any error messages returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Vikunja API.
  • The base URL for the Vikunja API must be configured in the node credentials.
  • The node uses HTTP requests to interact with the Vikunja API endpoints related to teams.

Troubleshooting

  • Common issues:

    • Invalid team ID or username: Ensure the team exists and the username is correct.
    • Insufficient permissions: The API key used must have rights to modify team memberships.
    • Network or API endpoint errors: Verify the API URL and network connectivity.
  • Error messages:

    • "Team not found": Check that the team ID or name is correct and accessible.
    • "User not found": Confirm the username exists in Vikunja.
    • "Unauthorized" or "Forbidden": Verify API credentials and permissions.

Resolving these usually involves verifying input parameters, checking API credentials, and ensuring the Vikunja server is reachable.

Links and References

Discussion