CIPP icon

CIPP

Interact with CIPP API

Actions129

Overview

This node operation allows users to add or remove members from a SharePoint site within a specified tenant. It is useful for managing SharePoint site permissions dynamically, such as adding a new user to a SharePoint group or removing an existing user. Practical examples include automating user access management in SharePoint sites for collaboration or compliance purposes.

Use Case Examples

  1. Add a user to a SharePoint site group to grant them access.
  2. Remove a user from a SharePoint site group to revoke their access.

Properties

Name Meaning
Tenant Filter The tenant ID or domain name to specify which tenant the operation applies to.
Group ID The identifier of the SharePoint group to which the user will be added or removed.
Add Boolean flag indicating whether to add (true) or remove (false) the user from the SharePoint group.
URL The web URL of the SharePoint site or OneDrive where the group exists.
SharePoint Type The root web template type of the SharePoint site.
User The user principal name (email or username) of the user to be added or removed.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • success - Indicates whether the operation to add or remove the SharePoint member was successful.
  • message - Additional information or error message related to the operation.

Dependencies

  • Requires authentication credentials to access the SharePoint API, typically an API key or OAuth token for the tenant.

Troubleshooting

  • Ensure the tenant ID or domain name is correct to avoid authentication errors.
  • Verify the Group ID and User principal name are valid and exist in the SharePoint site.
  • Check network connectivity and proxy settings if requests fail to reach the SharePoint API.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.
  • Timeout errors may occur if the SharePoint API is slow to respond; increase the timeout setting if needed.

Discussion