CIPP icon

CIPP

Work with the CIPP API
Join our community

Actions7

Overview

This node interacts with the CIPP API, specifically focusing on the "GDAP" resource and its "Get Invites" operation. It retrieves invitation data related to a specified relationship ID within the GDAP context. This is useful for scenarios where you need to programmatically fetch pending or active invites associated with a particular relationship in your system, such as managing access or monitoring invitations sent to partners or collaborators.

Practical examples include:

  • Automatically retrieving all invites linked to a specific relationship to audit or display them.
  • Integrating invite data into dashboards or reports.
  • Triggering workflows based on the presence or status of invites.

Properties

Name Meaning
Relationship ID The unique identifier of the relationship for which to retrieve invites.

Output

The node outputs JSON data containing the invites associated with the specified Relationship ID. The structure typically includes details about each invite, such as invitee information, status, and timestamps. No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the CIPP API.
  • The base URL for the API is configured via credentials and environment variables.
  • Proper permissions to access the GDAP resource and read invite data are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Relationship ID will result in no data or errors.
    • Authentication failures due to incorrect or expired API credentials.
    • Network connectivity problems preventing access to the CIPP API endpoint.

  • Error messages:

    • Authorization errors indicate issues with the provided API key; verify and update credentials.
    • "Relationship not found" or similar messages suggest the Relationship ID does not exist or is mistyped.
    • Timeout or connection errors require checking network settings and API availability.

Links and References

Discussion