OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation allows you to create a new user (principal) in the OpenProject system via its API. It is useful for automating user management tasks such as onboarding new team members or synchronizing users from other systems. For example, you can use this node to programmatically add a user with specified details like email, login, name, and language, optionally setting them as an admin and defining their activation status.

Properties

Name Meaning
Admin Boolean flag indicating if the new user should have administrative privileges (true/false).
Email The email address of the new user.
Login The login username for the new user.
Password The password for the new user. This can only be set during creation, not on updates.
First Name The first name of the new user.
Last Name The last name of the new user.
Status The current activation status of the user. Can only be set on creation, not on update.
Language The preferred language for the new user.

Output

The node outputs JSON data representing the newly created user object as returned by the OpenProject API. This typically includes all user details such as ID, email, login, names, admin status, language, and status. There is no binary output.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node expects the base URL of the OpenProject instance to be configured in the credentials.
  • The node uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Common issues:

    • Missing required fields such as email, login, first name, last name, or language will cause the API call to fail.
    • Attempting to set or update the password or status after creation will not work because these fields are only writable on creation.
    • Invalid or missing API credentials will result in authentication errors.
    • Network connectivity issues or incorrect base URL configuration can cause request failures.
  • Error messages:

    • Authentication errors usually indicate invalid or missing API keys; verify your credentials.
    • Validation errors from the API may specify which required fields are missing or incorrectly formatted.
    • HTTP 4xx or 5xx errors indicate client or server issues respectively; check the API documentation and server status.

Links and References

Discussion