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, types, statuses, priorities, and categories. Specifically for the User - Create operation, it allows you to create a new user in an OpenProject instance by providing essential user details.

Common scenarios where this node is beneficial include automating user onboarding processes, synchronizing user accounts from other systems into OpenProject, or bulk-creating users based on external data sources.

For example, you could use this node to automatically add new team members to your OpenProject workspace when they join your organization, ensuring they have access without manual setup.

Properties

Name Meaning
Email The email address of the user to be created.
Login The login username for the user account.
First Name The first name of the user.
Last Name The last name of the user.
Password The password for the user account (input is masked).

Output

The node outputs JSON data representing the newly created user resource as returned by the OpenProject API. This typically includes fields such as the user's ID, email, login, first name, last name, and other metadata assigned by OpenProject.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "id": "123",
  "email": "user@example.com",
  "login": "userlogin",
  "firstName": "John",
  "lastName": "Doe"
}

Dependencies

  • Requires an active OpenProject instance accessible via its REST API.
  • Needs an API key credential configured in n8n for authentication.
  • The node uses Basic Authentication with the API key encoded in the request headers.
  • The base URL of the OpenProject instance and the API key must be provided in the node credentials.

Troubleshooting

  • Error: The resource 'user' is not supported!
    This indicates an invalid resource parameter; ensure "User" is selected as the resource.

  • OpenProject error response: [message]
    This error comes directly from the OpenProject API. Common causes include:

    • Missing required fields (email, login, first name, last name, password).
    • Invalid or expired API key credential.
    • Network connectivity issues to the OpenProject server.
      To resolve, verify all required inputs are provided, check API key validity, and confirm network access.
  • The method 'POST' is not supported!
    This would indicate an internal issue with HTTP method selection; unlikely if using the node as intended.

  • If the node fails but "Continue On Fail" is enabled, errors will be returned in the output JSON under an error field.

Links and References

Discussion