Api clients
/
Ruby
/
V1
/
Methods
Jun 25, 2024
Remove UserID | Ruby API Client V1 (Deprecated)
Deprecated content
This documentation is for a deprecated version of Ruby API client .
Some features and settings may be missing or their usage may have changed.
Refer to the documentation for the
latest version of Ruby API client for up-to-date information.
Required API Key: Admin
Method signature
client.remove_user_id(String userID)
About this method
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
Remove a userID and its associated data
Copy
1
$client->removeUserId('myUserID1');
Parameters
userID
|
type: string
Required
userID to delete. |
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
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?