Zorus icon

Zorus

Interact with Zorus API

Actions13

Overview

This node interacts with the Zorus API to perform a search for groups based on various filtering and sorting criteria. It is useful in scenarios where you need to retrieve specific groups or lists of groups from the Zorus platform, such as managing user groups, syncing group-related options or addons to members, or integrating group data into workflows.

Practical examples include:

  • Searching for groups by name or UUID to fetch detailed information.
  • Filtering groups associated with a particular customer or policy.
  • Paginating through large sets of groups with control over page size and sorting.
  • Synchronizing group options or addons to their members automatically.

Properties

Name Meaning
Page The page number to retrieve in the paginated results (default is 1).
Page Size Number of groups to return per page (default is 10).
Sort Property The property by which to sort the returned groups (e.g., name, creation date).
Sort Ascending Whether to sort the results in ascending order (true) or descending order (false).
Name Contains Filter groups whose names contain this string.
UUID Equals Filter groups matching exactly this UUID.
Policy UUID Equals Filter groups associated with this specific policy UUID.
Customer UUID Equals Filter groups associated with this specific customer UUID.
Customer Name Contains Filter groups whose associated customer's name contains this string.
Synch Options To Members Whether to synchronize group options to its members (true or false).
Synch Addons To Members Whether to synchronize group addons to its members (true or false).

Output

The node outputs JSON data representing the groups that match the search criteria. Each item in the output typically includes details about a group such as its UUID, name, associated policies, customers, and other metadata as provided by the Zorus API.

If synchronization options or addons are enabled, the output may also reflect the status or result of those synchronization actions.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Zorus API.
  • The node makes HTTP requests to the base URL: https://developer.zorustech.com/api.
  • Proper configuration of the API key credential within n8n is necessary for successful execution.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Empty results: Verify that the filter parameters (e.g., UUIDs, names) are correct and exist in the Zorus system.
  • Pagination issues: If too few or no results appear, check the Page and Page Size values; they must be positive integers.
  • Sorting problems: Confirm that the Sort Property matches a valid sortable field recognized by the API.
  • Synchronization flags: If enabling synchronization options or addons, ensure that the groups and members support these features; otherwise, the operation might fail or have no effect.

Links and References

Discussion