Batch Assign UserIDs | JavaScript API Client V3 (Deprecated)

Deprecated content

This documentation is for a deprecated version of JavaScript API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of JavaScript API client for up-to-date information.

Required API Key: Admin

Method signature

client.assignUserIDs(
  {
    userIDs: array,
    clusterName: string
  },
  callback
);

See code examples

About this method

Assign multiple userIDs to a cluster.

Examples

Assign multiple users to a cluster

Copy

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

Copy
client.assignUserIDs({
  userIDs: ['myUserID1', 'myUserID2', 'myUserID3'],
  cluster: 'c1-test',
}, (err, content) => {
  if (err) throw err;

  console.log(content);
});

Copy
// This method is not yet available in scala.
</div>
<div data-target='snippet.pane' data-language='kotlin' class='snippet-body hidden'>```kotlin*
// This method is not yet available in Kotlin.

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:

alphanumeric caracters
-
.
(space)
*


            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

Copy

        {
  "createdAt": "2013-01-18T15:33:13.556Z"
}


          createdAt

string

Date at which the indexing job has been created.

Did you find this page helpful?