CIPP icon

CIPP

Work with the CIPP API

Overview

This node interacts with the CIPP API to retrieve information about tenants. Specifically, the "Get Tenant" operation fetches details of a single tenant by its name or ID. This is useful in scenarios where you need to access tenant-specific data for management, reporting, or integration purposes within your workflows.

Practical examples include:

  • Fetching tenant details to verify subscription status.
  • Retrieving tenant metadata before performing further actions like license assignment or domain management.
  • Integrating tenant information into dashboards or audit logs.

Properties

Name Meaning
Tenant Name or ID Select a tenant from a dropdown list or specify a tenant ID using an expression. This identifies which tenant's details to retrieve.

The dropdown options are dynamically loaded via a method that fetches available tenants.

Output

The node outputs JSON data containing the detailed information of the requested tenant. The exact structure depends on the CIPP API response but typically includes tenant identifiers, names, and related metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential configured for authenticating with the CIPP API.
  • The base URL for the API is set dynamically from the credentials.
  • The node relies on dynamic loading of tenant options via an internal method to populate the tenant selection dropdown.

Troubleshooting

  • Common issues:

    • Invalid or missing tenant ID/name: Ensure the tenant identifier is correct and exists in the system.
    • Authentication errors: Verify that the API key credential is valid and has necessary permissions.
    • Network or API endpoint issues: Confirm the base URL and network connectivity to the CIPP API.
  • Error messages:

    • "Tenant not found": Check if the tenant ID or name is correct.
    • "Authentication failed": Reconfigure the API key credential.
    • Timeout or connection errors: Validate network settings and API availability.

Links and References

Discussion