CIPP icon

CIPP

Interact with CIPP API

Actions18

Overview

The node named "CIPP" provides integration with the CIPP API, allowing users to interact programmatically with various resources such as tenants, users, groups, licenses, and calendar permissions. Specifically, for the "Tenant" resource and the "Edit Tenant" operation, this node enables updating tenant details like customer ID, tenant alias, and tenant groups.

This node is beneficial in scenarios where automated management of tenant information is required, such as synchronizing tenant data from an external system, bulk updating tenant attributes, or integrating tenant updates into a workflow automation process.

Example use cases:

  • Automatically update tenant aliases based on changes in a CRM system.
  • Modify tenant group assignments as part of onboarding or offboarding workflows.
  • Adjust customer IDs linked to tenants when migrating between systems.

Properties

Name Meaning
Customer ID Specify the customer ID to update for the tenant.
Tenant Alias Specify the tenant alias to update.
Tenant Groups Specify the tenant groups to update.

Output

The node outputs JSON data representing the response from the CIPP API after attempting to update the tenant. This typically includes the updated tenant details or confirmation of the successful update. The output structure aligns with the API's response schema for tenant updates.

If the node supports binary data output (not indicated here), it would represent any file or media content returned by the API, but for this operation, the output is purely JSON.

Dependencies

  • Requires an active connection to the CIPP API.
  • Needs an API authentication token configured via OAuth2 credentials within n8n.
  • The base URL for the API is dynamically set from the provided credentials.
  • Proper permissions on the API side to perform tenant updates are necessary.

Troubleshooting

  • Common Issues:

    • Invalid or expired API authentication token causing authorization failures.
    • Incorrect or missing tenant identifiers leading to "tenant not found" errors.
    • Insufficient permissions to update tenant data resulting in access denied errors.
    • Malformed input properties causing validation errors from the API.

  • Error Messages and Resolutions:

    • 401 Unauthorized: Check that the API credentials are valid and have not expired.
    • 404 Not Found: Verify that the specified tenant exists and the identifiers are correct.
    • 400 Bad Request: Ensure all required fields are correctly formatted and provided.
    • 403 Forbidden: Confirm that the API user has permission to edit tenant information.

Links and References

Discussion