Gigya Job Openings

Template_gs accountInfo response fields2

Skip to end of metadata
Go to start of metadata
     
UID string The unique user ID. This user ID should be used for login verification as described under Validate the UID Signature in the Social Login Process.
UIDSignature string The signature that should be used for login verification. See User.UID for more information.
signatureTimestamp string The GMT time of the response in UNIX time format, i.e., the number of seconds since Jan. 1st 1970. The timestamp should be used for login verification. See User.UID for more information.
UIDSignature string This property is deprecated in server to server REST calls!
signatureTimestamp string This property is deprecated in server to server REST calls!
loginProvider string The name of the provider that the user used in order to login.
isRegistered Boolean Indicates whether the user is registered. The user is registered once his registration has been finalized.
registeredTimestamp string The GMT time when the isRegistered parameter was set to true in UNIX time format, i.e., the number of seconds since Jan. 1st 1970.
registered string The time when the isRegistered parameter was set to true in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".
isVerified Boolean Indicates whether the account email is verified.
verifiedTimestamp string The GMT time when the isVerified parameter was set to true in UNIX time format, i.e., the number of seconds since Jan. 1st 1970.
verified string The time when the isVerified parameter was set to true in ISO 8601 format, i.e., "1997-07-16T19:20:30Z".
isActive> Boolean 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.
isLockedOut Boolean Indicates whether the account is currently locked out.
iRank integer 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.
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:
  • The number of friends this user has in all the networks to which he is connected through this site.
  • The number of times this user shared something in this site (per month).
  • The number of click backs that were made as a result of this user's shares.
lastLoginLocation JSON object The user's last login location. This includes the following fields:
  • country - a string representing the two-character country code.
  • state - a string representing the state, where available.
  • city - a string representing the city name.
  • lat - a double representing the latitude of the center of the city.
  • long - a double representing the longitude of the center of the city.
lastLoginTimestamp integer The time of the last login of the user in Unix time format, i.e., seconds since Jan. 1st 1970.
lastLogin string The time of the last login of the user in ISO 8601 format, i.e., "1997-07-16T19:20:30Z".
oldestDataUpdatedTimestamp integer The time when the oldest data of the object was refreshed in Unix time format, i.e., seconds since Jan. 1st 1970.
oldestDataUpdated string The time when the oldest data of the object was refreshed in ISO 8601 format, i.e., "1997-07-16T19:20:30Z".
lastUpdatedTimestamp integer 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.
lastUpdated string The time when the last update of the object occurred (either full or partial update) in ISO 8601 format, i.e., "1997-07-16T19:20:30Z".
createdTimestamp integer The time the account was created in Unix time format, i.e., seconds since Jan. 1st 1970.
created string The time the account was created in ISO 8601 format, i.e., "1997-07-16T19:20:30Z".
emails JSON object The email addresses belonging to the user. This includes the following fields:
  • verified - an array of strings representing the user's verified email addresses
  • unverified - an array of strings representing the user's unverified email addresses.

Note: emails must be specified explicitly in the include parameter in order to be included in the response.

regSource string A string representing the source of the registration. Note: regSource must be specified explicitly in the include parameter in order to be included in the response.
socialProviders string A comma-separated list of  the names of the providers to which the user is connected/logged in.
profile Profile object The user's profile information as described in the Profile object. The profile is returned in the response by default, but if the include parameter is used to specify other fields that should be provided in the response, the profile must also be specified explicitly in the include parameter.
data JSON object Custom data. Any data that you want to store regarding the user that isn't part of the Profile object.
identities array An array of Identity objects, each object represents a user's social identity. Each Identity object contains imported data from a social network that the user has connected to.
Note: identities must be specified explicitly in the include parameter in order to be included in the response (either identities-active or identities-all).