socialize.getUserInfo REST

Skip to end of metadata
Go to start of metadata

 

 

This method retrieves extended information regarding a user.

 

Request URL

Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

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

 

Parameters

RequiredNameTypeDescription
UID string The unique ID of the user with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user. See User.UID for more information.
  • The UID parameter is required when you call this method through one of the following interfaces:  PHP SDKPython SDKJava SDKNET SDK  or if you are using the REST API directly with Gigya's proprietary authorization method.
  • The UID parameter is not required when you call this method through one of the following interfaces: Android SDK, iOS SDK or if you are using an external OAuth2 SDK.
Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Social Login Implementation guide.
cidstring
A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.
includeAllIdentitiesBooleanThis parameter's default value is false. If set to 'true' you will receive all the user's identities, including those with expired sessions. Each  entry will have an attribute that will be 'true' when the session has expired for that provider (or is otherwise inactive) and 'false' if it is active.
extraFieldsstring

This parameter accepts a comma-separated list of additional data 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, likes, followersCount, followingCount, username, locale, verified, irank, timezone, and samlData.

Note: Before your application can retrieve Facebook data, the user must grant your application with access. Please make sure you have checked the check boxes that enable retrieving the relevant fields from Facebook in the Permissions page on Gigya's website. You may find more information in the Facebook Permissions section of our guide.

enabledProvidersstringA comma delimited list of providers from which to return user information in the response. 
If you do not set this parameter, by default the following providers are enabled: facebook, twitter, yahoo, linkedIn, messenger, google+, foursquare, vkontakte, renren, qq, sina, instagram, aol, blogger, wordpress.

In addition the following providers are supported and may be added explicitly: netlog, orangefrance, mixi, livedoor, paypal, paypaloauth, amazon, xing.

You may use the '*' sign as an indication to include all the default providers.

For example:

  • If you would like the API methods to apply to PayPalOAuth in addition to all the default providers, define: enabledProviders="*,paypaloauth".

If you would like the API methods to apply only to Facebook and Twitter, define: enabledProviders="facebook,twitter".

Note: This method applies to only connected providers.

disabledProvidersstringA comma delimited list of providers from which not to return user information in the response. If you do not set this parameter, by default no provider is disabled (i.e. the method applies to all connected providers).
For example, if you would like the method to apply to all providers except Google+ and Twitter, define: disabledProviders="googleplus, twitter".
   
format string Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are:
  • json
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
  • xml (default) - Deprecated. We do not support XML format anymore, but it is the default due to backwards compatibility. Please set the format parameter to either json or jsonp.
callback string This parameter is relevant only when the format parameter is set to jsonp (see above). In such case 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 occurs.
 includeiRankBooleanDeprecated. This parameter's default value is 'false'. If set to 'true' you will receive the user's iRank (influencer rank) in the response User object.

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
user dataUser objectInformation about the user. See JSON example below for the user data representation. Only fields with data are returned. Note that unlike client-based calls, the identities field returns an array and the capabilities field a comma separated string. 

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

Response Example

{
  "UID": "_gid_66zVIH4wFT9vWs1jIGMejXb89L7iEdzZa0QxhnzMo4Q=",
  "isSiteUser": true,
  "isConnected": true,
  "isLoggedIn": true,
  "isTempUser": false,
  "loginProvider": "facebook",
  "loginProviderUID": "100002035608959",
  "isSiteUID": false,
  "identities": [
    {
      "provider": "facebook",
      "providerUID": "100002035608959",
      "isLoginIdentity": true,
      "nickname": "Margaret Whitman",
      "photoURL": "http://graph.facebook.com/100002035608959/picture?type=large",
      "thumbnailURL": "http://graph.facebook.com/100002035608959/picture?type=square",
      "firstName": "Margaret",
      "lastName": "Whitman",
      "gender": "f",
      "age": "34",
      "birthDay": "7",
      "birthMonth": "7",
      "birthYear": "1977",
      "email": "autoreaduser93@gmail.com",
      "city": "New York, New York",
      "profileURL": "http://www.facebook.com/profile.php?id=100002035608959",
      "proxiedEmail": "",
      "allowsLogin": true,
      "isExpiredSession": false,
      "bio": "My About Me",
      "education": [{ "school" : "Stanford University", "schoolType" : "College", "startYear" : "2000" }],
      "favorites": { "interests" : [{ "name" : "C++", "category" : "Community" }], "activities" : [{ "name" : "sex box and jazz", "category" : "Interest" }], 
                          "books" : [], "music" : [{ "name" : "Rock music", "category" : "Musical genre" }], "movies" : [{ "name" : "Scarface™", "category" : 
                           "Movie" }], "television" : [{ "name" : "ABC Family’s 25 Days of Christmas", "category" : "Tv show" }] },
      "hometown": { "id" : "106566059380422", "name" : "New Orleans, Louisiana" },
      "languages": "English",
      "likes": [{ "name" : "FIFA 11", "category" : "Games/toys" }, { "name" : "ABC Family’s 25 Days of Christmas", "category" : "Tv show" }, { "name" : 
                    "Scarface™", "category" : "Movie" }, { "name" : "Rock music", "category" : "Musical genre" }, { "name" : "C++", "category" : "Community" }, 
                    { "name" : "Mahatma Ghandi", "category" : "Author" }, { "name" : "sex box and jazz", "category" : "Interest" }],
      "locale": "en_US",
      "religion": "Cristiano (sdfsfdsd)",
      "timezone": 2,
      "work": [{ "company" : "HP", "companyID" : "191187460289" }]
    },
    {
      "provider": "linkedin",
      "providerUID": "3XklgWtatO",
      "isLoginIdentity": false,
      "nickname": "James Cameron",
      "photoURL": "http://media.linkedin.com/mpr/mprx/0_6X3m4aO1-3gsczS8X_-l4uVmt84czng8kQzA4ugmS52Fo-EhEGACn2d8yaZHnlyuFFiKcI_AxCUn",
      "firstName": "James",
      "lastName": "Cameron",
      "gender": "",
      "age": "25",
      "birthDay": "5",
      "birthMonth": "3",
      "birthYear": "1986",
      "country": "Israel",
      "state": "Israel",
      "profileURL": "http://www.linkedin.com/pub/james-cameron/29/18/94b",
      "proxiedEmail": "",
      "allowsLogin": false,
      "isExpiredSession": false,
      "address": "Herzl 45, Bat Yam",
      "bio": "server architecture, mergers and acquisition",
      "certifications": [{ "name" : "My Certification" }],
      "education": [{ "school" : "Mykolajiv State Pedagogical University", "fieldOfStudy" : "English,Physics,Economics", "degree" : "MSc", "startYear" : 
                            "1995", "endYear" : "2000" }],
      "favorites": { "interests" : [{ "name" : "C++" }, { "name" : " Java" }] },
      "honors": "My Honors and Awards:",
      "industry": "Automotive",
      "languages": "English,French",
      "patents": [{ "title" : "My Patent", "date" : { "day" : 14, "month" : 3, "year" : 2005 } }],
      "publications": [{ "title" : "My full title", "date" : { "day" : 6, "month" : 6, "year" : 2006 } }],
      "skills": [{ "skill" : "C++, Java" }, { "skill" : "123" }, { "skill" : "FAS 123R" }],
      "specialties": "Union negotiation, purchasing, government liaison, branding and identity",
      "work": [{ "company" : "Dell", "companyID" : "1093", "title" : "Software Engineer", "startDate" : "2000-06", "industry" : "Information Technology and Services", 
                    "isCurrent" : true }]
    }
  ],
  "nickname": "Margaret Whitman",
  "photoURL": "http://graph.facebook.com/100002035608959/picture?type=large",
  "thumbnailURL": "http://graph.facebook.com/100002035608959/picture?type=square",
  "firstName": "Margaret",
  "lastName": "Whitman",
  "gender": "f",
  "age": "34",
  "birthDay": "7",
  "birthMonth": "7",
  "birthYear": "1977",
  "email": "autoreaduser93@gmail.com",
  "country": "Israel",
  "state": "Israel",
  "profileURL": "http://www.facebook.com/profile.php?id=100002035608959",
  "proxiedEmail": "",
  "capabilities": "Login, Friends, Notifications, Actions, Status, Photos, Places, Checkins",
  "providers": "facebook,linkedin",
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "12eafc4236994e41baccdca8d5dd32fe",
  "time": "2015-03-22T11:42:25.943Z",
  "bio": "My About Me",
  "education": [{ "school" : "Stanford University", "schoolType" : "College", "startYear" : "2000" }],
  "favorites": { "interests" : [{ "name" : "C++", "category" : "Community" }], "activities" : [{ "name" : "sex box and jazz", "category" : "Interest" }], 
                        "books" : [], "music" : [{ "name" : "Rock music", "category" : "Musical genre" }], "movies" : [{ "name" : "Scarface™", "category" : 
                        "Movie" }], "television" : [{ "name" : "ABC Family’s 25 Days of Christmas", "category" : "Tv show" }] },
  "hometown": { "id" : "106566059380422", "name" : "New Orleans, Louisiana" },
  "languages": "English",
  "likes": [{ "name" : "FIFA 11", "category" : "Games/toys" }, { "name" : "ABC Family’s 25 Days of Christmas", "category" : "Tv show" },
                { "name" : "Scarface™", "category" : "Movie" }, { "name" : "Rock music", "category" : "Musical genre" }, { "name" : "C++", "category" : "Community" }, 
                { "name" : "Mahatma Ghandi", "category" : "Author" }, { "name" : "sex box and jazz", "category" : "Interest" }],
  "locale": "en_US",
  "religion": "Cristiano (sdfsfdsd)",
  "timezone": 2,
  "work": [{ "company" : "HP", "companyID" : "191187460289" }],
  "address": "Herzl 45, Bat Yam",
  "certifications": [{ "name" : "My Certification" }],
  "honors": "My Honors and Awards:",
  "industry": "Automotive",
  "patents": [{ "title" : "My Patent", "date" : { "day" : 14, "month" : 3, "year" : 2005 } }],
  "publications": [{ "title" : "My full title", "date" : { "day" : 6, "month" : 6, "year" : 2006 } }],
  "skills": [{ "skill" : "C++, Java" }, { "skill" : "123" }, { "skill" : "FAS 123R" }],
  "specialties": "Union negotiation, purchasing, government liaison, branding and identity"
}