Api clients / Ruby / V1 / Methods

Get 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.get_user_id(String userID)

About this method# A

Returns the userID data stored in the mapping.

The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters.

Examples# A

Get userID#

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

Parameters# A

userID #
type: string
Required

userID to fetch.

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
4
5
6
{
  "userID": "user4",
  "clusterName": "c10-test",
  "nbRecords": 104,
  "dataSize": 17400
}
userID #
string

userID of the requested user.

clusterName #
string

Cluster on which the data of the user is stored.

nbRecords #
integer

Number of records this user has on the cluster.

dataSize #
integer

Data size taken by this user on the cluster.

Did you find this page helpful?