Table of contents
Description
This method retrieves extended information regarding a user.
Request URL
http[s]://socialize.gigya.com/socialize.getUserInfo
Parameters
| Required | Name | Type | Description |
| Required* | 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. * The UID parameter is required when you call this method through one of the following interfaces: PHP SDK, Java SDK, NET 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. |
| Optional | cid | string | A string of maximum 100 characters length. This string is associated with each transaction and will later appear on 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. The "Context ID" combo box lets you filter the report data by site/application context. |
| includeAllIdentities | Boolean | This parameter's default value is false. If set to 'true' you will receive all the user's identities, including those with expired sessions. Each <identity> entry will have an attribute <isExpiredSession> that will be 'true' when the session has expired for that provider (or is otherwise inactive) and 'false' if it is active. | |
| extraFields | string | 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, username, locale, verified, irank and timezone. 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. | |
| enabledProviders | string | A 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, myspace, foursquare, vkontakte, renren, qq, sina, kaixin, orkut, aol, blogger, wordpress, hyves, typepad, livejournal, verisign, openid, skyrock, vznet. In addition the following providers are supported and may be added explicitly: netlog, signon, orangefrance, mixi, livedoor, paypal, digg. 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 PayPal in addition to all the default providers, define: enabledProviders="*,paypal". If you would like the API methods to apply only to Facebook and Twitter, define: enabledProviders="facebook,twitter". Note - the method applies to only connected providers. | |
| disabledProviders | string | A 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="google,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:
|
|
| 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. | |
| includeiRank | Boolean | Deprecated. 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.
Note: the authorization parameters are required only if you are using the REST API directly. If you are using one of Gigya's SDKs then these parameters are not required, since the SDK implements the authorization method internally.
The set of required parameters is dependent on your selected method of authorization. There are two options:
- If you are conforming with the OAuth 2.0 standard, you will need to Pass an Access Token. For more information, please read the Using Gigya's REST API in compliance with OAuth 2.0 guide.
- If you are using Gigya's proprietary authorization method, you will need to pass the parameters specified here. Or, if you are making a call over HTTPS then you may pass the secret parameter instead of the timestamp, nonce and sig parameters. For more information, please read the Using Gigya's REST API with our proprietary authorization method guide.
Response Data
| Field | Type | Description |
| 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. |
| 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. |
| user data | User object | Information about the user. See JSON example below for the user data representation. |
Note: 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",
"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"
}
Comments