This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

Required API Key: Admin

Method signature
$client->assignUserId(string userID, string clusterName)

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Assign or Move a userID to a cluster.

The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID.

Examples

Read the Algolia CLI documentation for more information.

Assign a user to a cluster

1
$client->assignUserId('myUserID1', 'c1-test');

Parameters

userID
type: string
Required

userID to assign.

If userID is unknown, we will assign the userID to the cluster, otherwise the operation will move the userID and its associated data from its current cluster to the new one specified in parameter 2.

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 userID, until the first has finished. Any attempt will be rejected. it will be rejected.

The userID can contain:

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

Cluster name.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

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

Date at which the indexing job has been created.

Did you find this page helpful?