API Reference / API Methods / MultiClusters / Batch assign userIDs
Required API Key: Admin
Method signature
This method is not yet available in the PHP api client.

About this method # A

Assign multiple userIDs to a cluster.

Examples # A

Assign multiple users to a cluster#

1
// This method is not yet available in php.

Parameters # A

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:

  • alphanumeric caracters
  • -
  • .
  •   (space)
  • *
clusterName #
type: string
Required

Cluster name.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

1
2
3
{
  "createdAt": "2013-01-18T15:33:13.556Z"
}
createdAt #
string

Date at which the indexing job has been created.

Did you find this page helpful?
PHP v3