Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
The "Remove user id" operation under the "Clusters" resource in this Algolia node allows you to delete a specific user ID and all its associated data from the multi-cluster setup. This is useful for managing user data within Algolia's multi-cluster infrastructure, especially when you want to remove a user's footprint entirely from the clusters.
Typical use cases include:
- Cleaning up user data after account deletion or privacy requests.
- Managing cluster data by removing obsolete or inactive user IDs.
- Ensuring compliance with data retention policies by deleting user-specific data.
For example, if you have a user identified as "user1" whose data you want to completely remove from your Algolia clusters, this operation will delete that user ID and all related data.
Properties
| Name | Meaning |
|---|---|
| User ID | Unique identifier of the user who makes the search request. Must match pattern ^[a-zA-Z0-9 \-*.]+$. |
Output
The output of this operation is the JSON response returned by the Algolia API after attempting to delete the specified user ID. It typically contains information about the success or failure of the deletion request. The node does not output binary data for this operation.
Dependencies
- Requires an API key credential with appropriate permissions to manage clusters and user mappings in Algolia.
- The node must be configured with the Algolia application ID and API key credentials.
- Network access to Algolia's API endpoint:
https://<appId>.algolia.net.
Troubleshooting
- Invalid User ID Format: If the user ID does not match the required pattern (
^[a-zA-Z0-9 \-*.]+$), the API may reject the request. Ensure the user ID is correctly formatted. - Permission Errors: Insufficient API key permissions can cause authorization errors. Verify that the API key used has rights to modify cluster mappings.
- User ID Not Found: Attempting to remove a non-existent user ID might result in an error or no-op. Confirm the user ID exists before removal.
- Network Issues: Connectivity problems to Algolia's API endpoint can cause failures. Check network settings and firewall rules.
- Deprecated Multi-Cluster Operations: The multi-cluster operations are marked as deprecated; if issues arise, consider contacting Algolia support for alternatives.
Links and References
- Algolia Clusters - Remove User ID API
- Managing User IDs in Algolia Clusters
- Algolia API Authentication
- Algolia Support for Multi-Cluster Issues
This summary focuses on the "Remove user id" operation within the "Clusters" resource, describing its purpose, input properties, expected output, dependencies, and common troubleshooting tips based on static analysis of the provided source code and property definitions.