Actions27
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
Clusters → List user IDs
AI-generatedOverview
This node operation lists the user IDs assigned to a multi-cluster application in Algolia. It is useful for managing and monitoring user assignments across clusters in a multi-cluster setup. For example, it can be used to retrieve all user IDs currently mapped to clusters for auditing or administrative purposes.
Use Case Examples
- Retrieve a paginated list of user IDs assigned to clusters, specifying the page number and number of hits per page to control the size of the response.
- Use the options to customize pagination, such as setting hits per page to 50 and requesting the second page of results.
Properties
| Name | Meaning |
|---|---|
| Options | Allows setting pagination options for the API request, including the requested page and the number of hits per page. |
Output
JSON
userIDs- List of user IDs assigned to clusters.page- Current page number of the API response.hitsPerPage- Number of hits per page in the API response.totalHits- Total number of user IDs available.
Dependencies
- Algolia API key credential
Troubleshooting
- Ensure the API key credential has the necessary permissions to access cluster user mappings.
- If the response is empty, verify that user IDs have been assigned to clusters in the Algolia multi-cluster setup.
- Check network connectivity and base URL configuration to ensure requests reach the Algolia API endpoint.
- If pagination parameters are incorrect or out of range, adjust the 'page' and 'hitsPerPage' options accordingly.