CIPP icon

CIPP

Interact with CIPP API

Actions18

Overview

The node interacts with the CIPP API to perform operations related to various resources, including Groups. Specifically, for the "Group" resource and the "List Groups" operation, it retrieves a list of groups from the CIPP system. This can include optionally fetching members or owners of specified groups based on input parameters.

This node is beneficial in scenarios where you need to integrate group management data from CIPP into your workflows, such as syncing group information, auditing group memberships, or managing access controls programmatically.

Practical examples:

  • Automatically retrieving all groups within a tenant to synchronize with another system.
  • Fetching members or owners of a particular group to generate reports or trigger notifications.

Properties

Name Meaning
Group ID The identifier of a specific group to retrieve.
Members If specified, retrieves the members of the specified group.
Owners If specified, retrieves the owners of the specified group.
Tenant Filter A required filter specifying the tenant context to scope the group listing operation.

Output

The node outputs JSON data representing the groups retrieved from the CIPP API. The structure typically includes details about each group, such as its ID, name, and potentially nested arrays of members or owners if those options were specified.

If members or owners are requested, the output will include additional fields detailing these users associated with each group.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the CIPP API.
  • The base URL for the API is configured dynamically from the provided credentials.
  • The node expects the CIPP API to be accessible and properly configured for the authenticated user.

Troubleshooting

  • Common issues:
    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or missing tenant filter parameter may result in empty or unauthorized responses.
    • Specifying a Group ID that does not exist will likely return no results or an error.
  • Error messages:
    • Authentication errors indicate problems with the API key or OAuth token; verify credentials.
    • Validation errors related to missing required parameters (like tenant filter) require ensuring all mandatory inputs are set.
    • API connectivity issues suggest network problems or incorrect base URL configuration.

Links and References

Discussion