Actions199
- Collections Actions
- Forms Actions
- Actions Capabilities Actions
- Activities Actions
- Attachments Actions
- Budgets Actions
- Categories Actions
- Custom Actions Actions
- Custom Options Actions
- Documents Actions
- File Links Actions
- View File Link
- Delete File Link
- Open File Link
- Download File Link
- List Project Storages
- Get Project Storage
- Open Project Storage
- Create Storage
- Get Storage
- Update Storage
- Delete Storage
- Get Storage Files
- Prepare Storage File Upload
- Create Storage Folder
- Create Storage Oauth Credentials
- Open Storage
- Create Work Package File Link
- List Work Package File Links
- Grids Actions
- Groups Actions
- Help Texts Actions
- Memberships Actions
- Query Filter Instance Schema Actions
- News Actions
- Notifications Actions
- O Auth 2 Actions
- Posts Actions
- Principals Actions
- Priorities Actions
- Query Columns Actions
- Query Filters Actions
- Query Operators Actions
- Query Sort Bys Actions
- Relations Actions
- Previewing Actions
- Revisions Actions
- Roles Actions
- Time Entries Actions
- Time Entry Activities Actions
- Types Actions
- User Preferences Actions
- Wiki Pages Actions
- Work Schedule Actions
- Meetings Actions
- Values Property Actions
- Projects Actions
- Queries Actions
- Users Actions
- Statuses Actions
- Versions Actions
- Work Packages Actions
- Get Project Work Package Collection
- Create Project Work Package
- List Work Package File Links
- Form Create Work Package In Project
- Project Available Assignees
- List Work Packages
- Create Work Package
- Form Create Work Package
- List Work Package Schemas
- View Work Package Schema
- Delete Work Package
- View Work Package
- Update Work Package
- List Work Package Activities
- Comment Work Package
- Work Package Available Assignees
- Available Projects For Work Package
- List Available Relation Candidates
- Available Watchers
- Create Work Package File Link
- Form Edit Work Package
- Revisions
- Reminders
- List Watchers
- Add Watcher
- Remove Watcher
- Views Actions
Overview
This node interacts with the OpenProject API to list users (principals) within an OpenProject instance. It is useful for retrieving user information in a paginated and filtered manner, which can help automate user management, reporting, or synchronization tasks involving project members.
Common scenarios include:
- Fetching a list of users who belong to a specific group.
- Retrieving users filtered by status (e.g., invited, active).
- Searching users by name, login, or email.
- Sorting users based on specified criteria.
- Paginating through large user lists efficiently.
For example, you could use this node to get all invited users in a particular group to send them reminders or to synchronize user data with another system.
Properties
| Name | Meaning |
|---|---|
| Offset | Page number inside the requested collection. Used for pagination to specify which page of results to retrieve. |
| Page Size | Number of elements to display per page. Controls how many users are returned in one request. |
| Filters | JSON string specifying filter conditions. Supports filtering by user status, group membership, name (first/last/email), and login. Example filters include status equals "invited" or group equals a specific group ID. |
| Sort By | JSON string specifying sort criteria. Defines how the returned users should be ordered, e.g., by status ascending. |
| Select | Comma separated list of properties to include in the response. Allows selecting specific fields such as total count, user names, self links, etc. |
Output
The node outputs JSON data representing the list of users matching the query parameters. The structure typically includes:
total: Total number of users matching the filters.elements: An array of user objects, each containing selected properties likenameandself(a link to the user resource).self: A link to the current resource or query.
If binary data were involved (not in this case), it would be summarized accordingly, but here the output is purely JSON.
Dependencies
- Requires an API key credential for authenticating 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 Credentials: If authentication fails, verify that the API key and base URL are correct and have sufficient permissions.
- Malformed Filters or Sort JSON: Ensure that the JSON strings provided for filters and sorting are valid JSON and conform to the expected format described in the OpenProject API documentation.
- Pagination Issues: If no results appear, check that the offset and page size values are within valid ranges and that filters do not exclude all users.
- API Rate Limits or Connectivity: Network issues or rate limiting by the OpenProject server may cause errors; retry after some time or check network connectivity.