OpenProjectInstall

Overview

This node operation lists principals (users, groups, or placeholder users) from an OpenProject instance. It allows filtering and selecting specific properties of the principals to retrieve. This is useful for workflows that need to manage or analyze user/group data, such as syncing user information, auditing membership in projects, or generating reports on active users.

Practical examples:

• Retrieve all active users belonging to a specific project.
• List all groups with their names and IDs for further processing.
• Filter principals by status to find locked or invited users.

Properties

Output

The output JSON contains a list of principals matching the filter criteria. The structure typically includes:

• total: Total number of principals found.
• elements: An array where each element represents a principal object with requested properties such as name, self (URL to the principal resource), and other selected fields.

No binary data output is produced by this node.

Dependencies

• Requires an API key credential to authenticate with the OpenProject API.
• Needs the base URL of the OpenProject instance configured in credentials.
• Depends on the OpenProject REST API being accessible and properly configured.

Troubleshooting

• Invalid filter JSON: If the Filters property contains malformed JSON, the API request will fail. Ensure the JSON syntax is correct.
• Unsupported filter keys: Using unsupported filter keys may result in empty results or errors. Use only supported filters (type, member, name, any_name_attribute, status).
• Authentication errors: If the API key or URL is incorrect, authentication will fail. Verify credentials and endpoint URL.
• Empty results: If no principals match the filters, the output will have zero elements. Adjust filters accordingly.
• API rate limits or downtime: Network issues or API limits can cause failures; check connectivity and API status.

Links and References

• OpenProject API Queries Endpoint
• OpenProject Official Documentation