CIPP icon

CIPP

Work with the CIPP API
Join our community

Actions7

Overview

The node integrates with the CIPP API to manage GDAP (Granular Delegated Admin Privileges) invites. Specifically, the "Create GDAP Invite" operation allows users to generate an invitation for GDAP roles. This is useful in scenarios where an organization wants to delegate specific administrative privileges securely by inviting external users or partners with defined roles.

Practical examples include:

  • Inviting a partner organization to manage certain aspects of your tenant with predefined roles.
  • Automating the creation of GDAP invites as part of onboarding workflows for external administrators.

Properties

Name Meaning
Use All Existing Roles A boolean option to decide whether to use all existing GDAP roles for the invite (true), or specify particular roles (false).
GDAP Roles Names or IDs When not using all roles, select one or more specific GDAP roles by name or ID to assign in the invite. The list is dynamically loaded from available roles.

Output

The node outputs JSON data representing the result of the GDAP invite creation request. This typically includes details about the created invite such as invite ID, status, assigned roles, and possibly metadata about the invitee or expiration.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the CIPP API.
  • The base URL for the API is configured via credentials.
  • Dynamic loading of GDAP roles depends on the getGDAPRoleOptions method, which fetches available roles from the API.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying role IDs that do not exist or are not accessible may result in errors.
    • Network connectivity problems can prevent communication with the CIPP API.

  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Role-related errors: Ensure that the selected roles exist and the user has access to them.
    • Validation errors: Check that input properties conform to expected types and constraints.

Links and References

Discussion