Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTML
	</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">iRank</td>
 <td class="confluenceTd secondTd">integer</td>
 <td class="confluenceTd clean_r">Influencer rank of the user. The iRank is a number between 0-99, which denotes the percentile location of the user in comparison to all other site users as a site influencer. For example, if a user's iRank equals 60, this means that 60% of the site users influence less than this user, or in other words, this user is in the top 40% of site influencers.<br /> 
The iRank is calculated based on the amount of exposure this user provides the site. The calculation is done for the past several months, where recent activities receive higher ranks. The iRank is per site (per API key), the same user may have different ranks for different domains. The iRank calculation uses the following parameters: 
  <ul>
   <li>The number of <strong>friends</strong> this user has in all the networks to which he is connected through this site.</li>
   <li>The number of times this user <strong>shared</strong> something in this site (per month).</li>
   <li>The number of <strong>click backs</strong> that were made as a result of this user's shares.</li>
  </ul>
 </td>
</tr>
<tr>
 <td class="confluenceTd clean_l">isActive</td>
 <td class="confluenceTd secondTd">Boolean</td>
 <td class="confluenceTd clean_r">Indicates whether the account is active. The account is active once the user creates it even without finalizing it. The account can be deactivated, but it will still be registered if the registration process has been finalized.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">isLockedOut</td> 
 <td class="confluenceTd secondTd">Boolean</td> 
 <td class="confluenceTd clean_r">Indicates whether the account is currently locked out.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">isRegistered</td>
 <td class="confluenceTd secondTd">Boolean</td>
 <td class="confluenceTd clean_r">Indicates whether the user is registered. The user is registered once his registration has been finalized.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">isVerified</td>
 <td class="confluenceTd secondTd">Boolean</td>
 <td class="confluenceTd clean_r">Indicates whether the account email is verified.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">lastLogin</td> 
 <td class="confluenceTd secondTd">string</td>
 <td class="confluenceTd clean_r">The time of the last login of the user in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".</td> 
</tr>
<tr>
 <td class="confluenceTd clean_l">lastLoginLocation</td>
 <td class="confluenceTd secondTd">JSON object</td>
 <td class="confluenceTd clean_r">The user's last login location. This includes the following fields: 
  <ul>
   <li><strong>country</strong> - a string representing the two-character country code.</li>
   <li><strong>state</strong> - a string representing the state, where available.</li>
   <li><strong>city</strong> - a string representing the city name.</li>
   <li><strong>coordinates</strong> - an object containing:</li>
      <ul>
	     <li><strong>lat</strong> - a double representing the latitude of the center of the city.</li>
         <li><strong>lon</strong> - a double representing the longitude of the center of the city.</li>
	  </ul>
   
  </ul>
 </td>
</tr>
<tr>
 <td class="confluenceTd clean_l">lastLoginTimestamp</td>
 <td class="confluenceTd secondTd">integer</td>
 <td class="confluenceTd clean_r">The time of the last login of the user in Unix time format including milliseconds (i.e., the number of seconds since Jan. 1st 1970 * 1000).</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">lastUpdated</td>
 <td class="confluenceTd secondTd">string</td>
 <td class="confluenceTd clean_r">The time when the account object was last updated (either full or partial update) in ISO 8601 format, e.g., "1997-07-16T19:20:30Z". This is updated when any change is made to the account, for example, when a password is changed or a user logs in. </td>
</tr>
<tr>
 <td class="confluenceTd clean_l">lastUpdatedTimestamp</td>
 <td class="confluenceTd secondTd">integer</td>
 <td class="confluenceTd clean_r">The time when the last update of the object occurred (either full or partial update) in Unix time, i.e., seconds since Jan. 1st 1970. Based on <a href="https://en.wikipedia.org/wiki/Unix_time" target="_blank">Unix time</a> including milliseconds, based on when the 'lastUpdated', 'Report AccountsFirstLogin' or 'AccountsReturnedLogin' eventevents are fired.</td>
</tr>
<tr> 
 <td class="confluenceTd clean_l">loginIDs</td>
 <td class="confluenceTd secondTd">JSON object</td> 
 <td class="confluenceTd clean_r">The user's login identifiers. This includes the following fields: 
  <ul>
   <li><em><strong>username</strong></em> - a string representing the username</li>
   <li><em><strong>emails</strong></em> - an array of strings representing email addresses</li>
   <li><em><strong>unverifiedEmails</strong></em> - an array of strings representing email addresses that were not validated</li>
  </ul>
<p>Note: <strong><em>loginIDs</em></strong> must be specified explicitly in the <strong><em>include</em></strong> parameter in order to be included in the response.</p>
 </td>
</tr>
<tr>
 <td class="confluenceTd clean_l">loginProvider</td>
 <td class="confluenceTd secondTd">string</td> 
 <td class="confluenceTd clean_r">The name of the provider that the user used in order to login.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">oldestDataUpdated</td>
 <td class="confluenceTd secondTd">string</td>
 <td class="confluenceTd clean_r">The time when the oldest data of the object was refreshed in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".</td>
</tr>
<tr>
 <td class="confluenceTd clean_l"><span>oldestDataUpdatedTimestamp</span></td>
 <td class="confluenceTd secondTd">integer</td>
 <td class="confluenceTd clean_r">The time when the oldest data of the object was refreshed in Unix time format including milliseconds (i.e., the number of seconds since Jan. 1st 1970 * 1000).</td>
</tr>
<tr id="ifJS" class=""><!-- ********************* ONLY AVAILABLE VIA REST ************************* -->
 <td class="confluenceTd clean_l">password</td> 
 <td class="confluenceTd secondTd">JSON object</td> 
 <td class="confluenceTd clean_r">The user's <b>Site</b> account password details. Includes the following: 
  <ul>
   <li><em><strong>hash</strong></em> - the hashed password</li>
   <li><em><strong>hashSettings</strong></em> - object includes:<br />
		<ul>
			<li><strong>algorithm</strong> - Represents the hash algorithm used to encrypt the password.</li>
			<li><strong>rounds</strong> - Represents the number of iterations to perform the hashing.</li>
			<li><strong>salt</strong> - Represents the BASE64 encoded value of the salt.</li>
			<li><strong>format</strong> - Represents the template for merging clear-text passwords. This is only returned if the <strong>pwHashFormat</strong> parameter was set during account import and until the user's first login to Gigya (when the user's password is rehashed per the site's settings). See the <a href="/display/GD/RaaS+Import+Guide">RaaS Import Guide</a> for additional information.</li>
		</ul>
	</li>
  </ul>
 </td>
</tr><!-- ********************* /nonJS **************************** -->
<tr>
 <td class="confluenceTd clean_l">profile</td> 
 <td class="confluenceTd secondTd"><ac:link><ri:page ri:content-title="Profile (REST)" ri:space-key="GD"/><ac:plain-text-link-body><![CDATA[Profile]]></ac:plain-text-link-body></ac:link><a href="/display/GD/Profile JS">Profile</a> object</td>
 <td class="confluenceTd">The user's profile information as described in the <ac:link><ri:page ri:content-title="Profile (REST)" ri:space-key="GD"/><ac:plain-text-link-body><![CDATA[Profile]]></ac:plain-text-link-body></ac:link> object. The <em><strong>profile</strong></em> is returned in the response by default, but if the <strong><em>include</em></strong> parameter is used to specify other fields that should be provided in the response, the<em><strong> profile </strong></em>must also be specified explicitly in the <strong><em>include</em></strong> parameter.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">rbaPolicy</td>
 <td class="confluenceTd secondTd">string</td>
 <td class="confluenceTd clean_r">The current <a href="/display/GD/Accounts+RBA+Policy+Object">RBA Policy</a> defined for the specified user.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">registered</td>
 <td class="confluenceTd secondTd">string</td>
 <td class="confluenceTd clean_r">The time when the <strong><em>isRegistered</em></strong> parameter was set to true in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">registeredTimestamp</td>
 <td class="confluenceTd secondTd">string</td> 
 <td class="confluenceTd clean_r">The GMT time when the <strong><em>isRegistered</em></strong> parameter was set to true in UNIX time format, i.e., the number of seconds since Jan. 1st 1970.<a href="https://en.wikipedia.org/wiki/Unix_time" target="_blank">UNIX time</a> format, including milliseconds.</td>
</tr>

<tr>
 <td class="confluenceTd clean_l">regSource</td> 
 <td class="confluenceTd secondTd">string</td> 
 <td class="confluenceTd clean_r">A string representing the source of the registration. Can be used to set varying destination pages in accounts.setPolicies.</td> 
</tr>
<tr> 
 <td class="confluenceTd clean_l">socialProviders</td>
 <td class="confluenceTd secondTd">string</td>
 <td class="confluenceTd clean_r">A comma-separated list of  the names of the providers to which the user is connected/logged in.</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">verified</td>
 <td class="confluenceTd secondTd">string</td>
 <td class="confluenceTd clean_r">The time when the <strong><em>isVerified</em></strong> parameter was set to true in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".</td>
</tr>
<tr>
 <td class="confluenceTd clean_l">verifiedTimestamp</td>
 <td class="confluenceTd secondTd">string</td> 
 <td class="confluenceTd clean_r">The GMT time when the <strong><em>isVerified</em></strong> parameter was set to true in Unix time format including milliseconds (i.e., the number of seconds since Jan. 1st 1970 * 1000).</td>
</tr>
</tbody> 
</table>

...