Api clients / Ruby / V1 / Methods

Remove UserID | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

Required API Key: Admin
Method signature
client.remove_user_id(String userID)

About this method# A

Remove a userID and its associated data from the multi-clusters.

Even if the userID doesn’t exist, the request to remove the userID will still succeed because of the asynchronous handling of this request.

Examples# A

Remove a userID and its associated data#

1
$client->removeUserId('myUserID1');

Parameters# A

userID #
type: string
Required

userID to delete.

Response# A

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
{
  "deletedAt": "2013-01-18T15:33:13.556Z"
}
deletedAt #
string

Date at which the indexing job has been created.

Did you find this page helpful?