Assign or Move userID

Required API Key: Admin

Method signature

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

client.assign_user_id(String userID, String clusterName)

client.assignUserID(string userID, string cluster)

client.assign_user_id(str userID, str clusterName)

client.assignUser(
  withID userID: UserID,
  toClusterWithName clusterName: ClusterName,
  requestOptions: RequestOptions? = nil,
  completion: Result<Creation> -> Void
)

suspend fun ClientSearch.assignUserID(
    userID: UserID,
    clusterName: ClusterName,
): Creation

client.AssignUserID(String userID, String clusterName)

client.assignUserID(String userID, String clusterName)

client.AssignUserID(String userID, String clusterName)

This method is not yet available in the scala api client.

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

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

Copy

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

1
2
3
4
5
client.assignUser(withID: "myUserID1", toClusterWithName: "c1-test") { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Parameters

Parameter Description

Parameter	Description
`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.


            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

Copy

          {
  "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?