CIPP icon

CIPP

Interact with CIPP API

Overview

The node interacts with the CIPP API, specifically allowing operations on various resources including Groups. For the "Group" resource and the "Create Or Add Group" operation, it enables users to create a new group or add to an existing group within a specified tenant context. This is useful in scenarios where managing user groups across multiple tenants is required, such as setting up access controls, organizing users for permissions, or automating group management workflows.

Practical examples:

  • Creating a new group for a tenant to organize users by department.
  • Adding users or entities to an existing group within a tenant.
  • Automating group creation during onboarding processes in multi-tenant environments.

Properties

Name Meaning
Selected Tenants A string representing one or more tenants selected for the operation (optional).
Tenant ID The unique identifier of the tenant where the group will be created or modified (required).
Default Domain Name The default domain name associated with the group (optional).

Output

The node outputs JSON data representing the result of the create or add group operation. This typically includes details about the group created or updated, such as its identifiers, associated tenants, and domain information. There is no indication that the node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating with the CIPP API.
  • The base URL for API requests is constructed from the provided credentials.
  • The node expects the CIPP API to be accessible and properly configured for the authenticated user.

Troubleshooting

  • Missing Tenant ID: Since Tenant ID is required, omitting it will likely cause errors. Ensure this property is always set.
  • API Authentication Errors: If the API key or OAuth2 token is invalid or expired, authentication will fail. Verify credentials and refresh tokens if necessary.
  • Invalid Tenant or Group Data: Providing incorrect tenant IDs or malformed group data may result in API errors. Double-check input values.
  • Network Issues: Connectivity problems to the CIPP API endpoint can cause request failures. Confirm network access and API availability.

Links and References

Discussion