OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node integrates with the OpenProject API to manage various resources such as projects, users, work packages, time entries, versions, and others. Specifically for the User - Update operation, it updates an existing user's details in OpenProject by sending a PATCH request to the API with the new user information.

Common scenarios where this node is beneficial include:

  • Automating user profile updates in OpenProject from other systems.
  • Synchronizing user data changes across platforms.
  • Bulk updating user information based on external triggers or workflows.

For example, you could use this node to update a user's first and last name after receiving updated employee information from an HR system.

Properties

Name Meaning
User ID The unique identifier of the user to update. This is required to specify which user record to modify.
First Name The new first name of the user.
Last Name The new last name of the user.

Output

The node outputs the JSON response returned by the OpenProject API after the update operation. This typically includes the updated user object with its current properties as stored in OpenProject.

The output structure is:

{
  "json": {
    // Updated user object fields as returned by OpenProject API
  }
}

No binary data is produced by this node.

Dependencies

  • Requires an active connection to an OpenProject instance via its REST API.
  • Needs an API key credential configured in n8n for authentication.
  • Uses HTTP Basic Authentication with the API key encoded in base64.
  • Relies on the axios library for making HTTP requests.

Troubleshooting

  • Error: "OpenProject error response: ..."
    This indicates the OpenProject API returned an error message. Common causes include invalid user ID, insufficient permissions, or malformed data. Check the error message for specifics and verify the input parameters.

  • Error: "The resource 'user' is not supported for update operation!"
    This would occur if the resource or operation parameters are incorrectly set. Ensure that the resource is "user" and the operation is "update".

  • Authentication errors
    If the API key is missing or incorrect, the node will fail to authenticate. Verify the API key credential configuration.

  • Network issues
    Connectivity problems to the OpenProject server will cause request failures. Confirm network access and correct base URL.

Links and References

Discussion