ids.getAccountInfo REST

Skip to end of metadata
Go to start of metadata

Note: If you plan on integrating Gigya's Profile Management (IDS), we highly recommend reading the Identity Storage Guide. Profile Management (IDS) is a premium platform that requires separate activation. If it is not yet a part of your existing site package, please contact Gigya Support via the Support link in the top menu of your Console Dashboard or email support@gigya.com.

Description

This API retrieves user account data.

 

Request URL

Where <Data_Center_ID> is:
  • us1 - For the US data center.
  • eu1 - For the European data center.
  • au1 - For the Australian data center.
  • ru1 - For the Russian data center.

If you are not sure of your site's data center, see Finding Your Site's Data Center.

Parameters

RequiredNameTypeDescription
UID*string

The unique ID of the user for which to retrieve data. Use either this parameter or regToken.

If you call this API through an external OAuth2 SDK, then the UID may be passed implicitly within the access_token.

* You are required to pass only one of the parameters either UID or regToken.

regToken*string

The regToken returned from accounts.initRegistrationaccounts.register or accounts.login API calls when the registration process has not been finalized.

Please note that the regToken you receive from Gigya is valid for only one hour.

* You are required to pass only one of the parameters either UID or regToken.

includestring A comma-separated list of fields to include in the response. The possible values are: identities-active, identities-allloginIDsemailsprofile, data, and irank. The default value is "profile,data" so if this parameter is not used, the response will return the Profile and data objects. Note: Make sure the parameter does not contain spaces between the values.
extraProfileFieldsstring This parameter accepts a comma-separated list of additional social profile fields to retrieve. The current valid values are: languages, address, phones, education, honors, publications, patents, certifications, professionalHeadline, bio, industry, specialties, work, skills, religion, politicalView, interestedIn, relationshipStatus, hometown, favorites, username, locale, verified, timezone, and samlData.
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 

Response Data

FieldTypeDescription
 
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
statusReason string A brief explanation of the status code.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
 
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 as described under Validate the UID Signature in the Social Login Process.
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 as described under Validate the UID Signature in the Social Login Process.
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).
 

A field that does not contain data will not appear in the response.

Response Example

{
  "UID": "ff3c8368d1c7e",
  "UIDSignature": "5LA3g3qTmf0GPE=",
  "signatureTimestamp": "1344413375",
  "loginProvider": "facebook",
  "isRegistered": true,
  "isActive": true,
  "isVerified": true,
  "socialProviders": "site,facebook",
  "profile": {
    "email": "Joe@hotmail.com",
    "firstName": "Joe",
    "lastName": "Smith",
    "age" : "31",
    "gender" : "m",
    "country" : "US"
  },
  "data": {
    "newsletter": "true",
    "forums" : "news,entertainment"
  },
  "identities": [
    {
      "provider": "site",
      "providerUID": "d1c7e",
      "isLoginIdentity": false,
      "allowsLogin": false,
      "isExpiredSession": false,
      "lastUpdated": "2012-08-08T08:07:59.133Z",
      "lastUpdatedTimestamp": 1344413279133,
      "oldestDataUpdated": "2012-08-08T08:07:59.133Z",
      "oldestDataUpdatedTimestamp": 1344413279133
    },
    {
      "provider": "facebook",
      "providerUID": "k97y",
      "isLoginIdentity": true,
      "gender": "m",
      "email": "Joe@hotmail.com",
      "firstName": "Joe",
      "lastName": "Smith",
      "age" : "31",
      "country" : "US"
      "allowsLogin": true,
      "isExpiredSession": false,
      "lastUpdated": "2012-09-08T08:07:59.133Z",
      "lastUpdatedTimestamp": 1344413274523,
      "oldestDataUpdated": "2012-09-08T08:07:59.133Z",
      "oldestDataUpdatedTimestamp": 1344413276453
    }
  ],
  "created": "2012-08-08T08:07:59.128Z",
  "createdTimestamp": 1344413279128,
  "lastLogin": "2012-08-08T08:09:17Z",
  "lastLoginTimestamp": 1344413357000,
  "lastUpdated": "2012-09-08T08:07:59.133Z",
  "lastUpdatedTimestamp": 1344413279133,
  "oldestDataUpdated": "2012-08-08T08:07:59.133Z",
  "oldestDataUpdatedTimestamp": 1344413279133,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "9999996",
  "time": "2015-03-22T11:42:25.943Z"
}