OpenProjectInstall

Overview

This node interacts with the OpenProject API to list roles available in the system. It is useful for retrieving role information, such as which roles are grantable or applicable to certain units (e.g., project or system). Typical use cases include automating user management workflows, syncing roles with other systems, or dynamically populating role selections in other automation steps.

For example, you might use this node to fetch all system-level roles that can be assigned to users, then use that data to control access permissions programmatically.

Properties

Output

The node outputs a JSON array containing role objects matching the specified filters. Each role object typically includes details such as role ID, name, and attributes indicating its scope and grantability.

No binary data output is produced by this node.

Dependencies

• Requires an API key credential for authenticating with the OpenProject API.
• The base URL of the OpenProject instance must be configured in the node credentials.
• The node depends on the OpenProject REST API being accessible and properly configured to allow role queries.

Troubleshooting

• Invalid Filter JSON: If the filter property contains malformed JSON, the node will fail to parse it, resulting in an error. Ensure the filter string is valid JSON.
• API Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Verify that the API key and base URL are correctly set.
• Unsupported Filters: Using filters other than grantable or unit may result in no data or errors from the API.
• Network Issues: Connectivity problems to the OpenProject server will cause request failures. Check network access and firewall settings.

Links and References

• OpenProject API Queries Endpoint Documentation
• OpenProject Roles API Overview (general reference)