CIPP icon

CIPP

Interact with CIPP API

Overview

This node interacts with the CIPP API to retrieve various data related to tenants, users, groups, licenses, and calendar permissions. Specifically, for the "Tenant" resource and the "List Shared Mailbox Statistics" operation, it fetches statistical information about shared mailboxes within a specified tenant. This is useful in scenarios where administrators need to monitor or audit mailbox usage and performance metrics across different tenants.

Practical examples include:

  • Generating reports on shared mailbox activity for a particular tenant.
  • Monitoring mailbox statistics to optimize resource allocation.
  • Auditing mailbox usage for compliance or troubleshooting purposes.

Properties

Name Meaning
Tenant Filter Specify the tenant ID to get details for. This is a required string input identifying which tenant's shared mailbox statistics to retrieve.

Output

The node outputs JSON data containing the shared mailbox statistics for the specified tenant. The exact structure depends on the CIPP API response but generally includes statistical metrics related to shared mailboxes such as counts, usage data, or other relevant statistics.

If the node supports binary data output (not indicated here), it would typically represent attachments or files related to the mailbox statistics, but this is not evident from the provided code.

Dependencies

  • Requires an API key credential for authenticating with the CIPP API.
  • The base URL for the API is configured dynamically from the credentials (ApiUrl).
  • The node sends requests with Accept: application/json and Content-Type: application/json headers.
  • Proper configuration of the API URL and authentication credentials in n8n is necessary.

Troubleshooting

  • Common issues:

    • Missing or incorrect tenant ID in the "Tenant Filter" property will result in errors or empty responses.
    • Invalid or expired API credentials can cause authentication failures.
    • Network connectivity issues to the CIPP API endpoint may prevent successful requests.
  • Error messages:

    • Authentication errors typically indicate problems with the API key or OAuth token; verify and update credentials.
    • Validation errors may occur if the tenant ID format is incorrect; ensure the tenant ID matches expected patterns.
    • Timeout or connection errors suggest network issues; check connectivity and API availability.

Links and References

Discussion