Batch Assign UserIDs
This method is not yet available in the PHP api client.
About this method
You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
Assign multiple userIDs to a cluster.
Examples
Assign multiple users to a cluster
1
// This method is not yet available in php.
Parameters
userIDs
|
type: array
Required
userIDs to assign. Note you cannot move users with this method. If you have already called this method, and it is still running, you will not be able to run this method again for the same userIDs, until the first has finished. Any attempt will be rejected. A userID can contain:
|
clusterName
|
type: string
Required
Cluster name. |
Response
In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.
JSON format
1
2
3
{
"createdAt": "2013-01-18T15:33:13.556Z"
}
createdAt
|
string
Date at which the indexing job has been created. |