CIPP icon

CIPP

Work with the CIPP API

Overview

This node integrates with the CIPP API to retrieve multiple user records within a specified tenant. It is designed to fetch a list of users filtered by tenant and optionally refined using a graph filter query. This operation is useful in scenarios where you need to manage or analyze user data across different tenants, such as generating reports, syncing user information, or auditing user access.

Practical examples include:

  • Retrieving all users for a specific tenant to display in a dashboard.
  • Filtering users based on certain attributes using a graph filter to target specific subsets.
  • Automating user management tasks by fetching user lists programmatically.

Properties

Name Meaning
Tenant Name or ID Select the tenant by name or ID from a dropdown list or specify dynamically via an expression.
Graph Filter A string to apply a graph filter query to refine the search results when retrieving users.

Output

The node outputs JSON data containing an array of user objects matching the specified tenant and optional graph filter criteria. Each user object typically includes user details as returned by the CIPP API.

If binary data were involved (not indicated here), it would represent file contents or attachments related to users, but this node focuses on JSON user data output.

Dependencies

  • Requires an API key credential for authenticating with the CIPP API.
  • The base URL for the API is configured via credentials.
  • Uses internal methods to load options dynamically for tenants and other selections.

Troubleshooting

  • Empty Results: If no users are returned, verify that the tenant ID/name is correct and that the graph filter syntax is valid.
  • Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Invalid Filter Syntax: The graph filter must conform to the expected query format; invalid filters may cause errors or empty responses.
  • Network Issues: Check connectivity to the CIPP API endpoint configured in credentials.

Links and References

Discussion