OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node operation creates a new membership in the OpenProject system. Memberships typically link users (principals) to projects with specific roles, defining their permissions and access within that project. This operation is useful when automating user management workflows, such as adding team members to projects programmatically or integrating user provisioning from external systems.

Practical examples:

  • Automatically add a user to a project with a defined role when onboarding new employees.
  • Assign multiple roles to a user in a project based on external criteria.
  • Integrate project membership creation into a larger workflow that manages project setup and user assignments.

Properties

Name Meaning
Links JSON object specifying the related resources for the membership creation:
- principal: The user or entity to be added, including API endpoint and method.
- roles: Array of roles assigned to the principal.
- project: The project to which the membership applies.
Meta JSON object containing metadata for the request:
- notificationMessage: Message details formatted in markdown, raw text, and HTML.
- sendNotification: Boolean indicating whether to send a notification about the membership creation.

Output

The node outputs JSON data representing the response from the OpenProject API after creating the membership. This typically includes details of the newly created membership such as its ID, associated principal, roles, and project information.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The base URL for the OpenProject instance must be configured in the node credentials.
  • The node uses the OpenProject REST API endpoints to perform membership creation.

Troubleshooting

  • Invalid or missing principal/project/role data: Ensure the _links JSON property correctly specifies valid references to existing principals, roles, and projects. Invalid IDs or malformed JSON will cause API errors.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to create memberships.
  • Notification issues: If notifications are not sent despite sendNotification being true, check the OpenProject server settings for notification configurations.
  • Malformed JSON input: The _links and _meta properties expect valid JSON strings. Improper formatting will result in parsing errors before the API call.

Links and References

Discussion