This method is used to retrieve extended information regarding the current user. The response of this method includes a User object enfolding user data. See the User object page for the full specification of the available information.
Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer toREST API > socialize.getUserInfo.
The Gigya service supports a mechanism to verify the authenticity of the getUserInfo process.
If the global configuration object's signIDs field is set to 'true', Gigya "signs" the UID field received in the response with a cryptographic signature to prevent fraud.
The User object that you receive in the response has a cryptographic signature (UIDSignature data member) provided by Gigya.
We highly recommend verifying the authenticity of the signature to prove that it has indeed originated from Gigya rather than somewhere else.
Please follow the instruction in the Signature Validation Process section in the Security page of the Developer's Guide.
The following table lists the available parameters:
A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes.
The callback function should be defined with the following signature: functionName(Response).
The "Response Object Data Members" table below provides specification of the data that is passed to the callback function.
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.
|||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. The identities are received in the response: response.user.identities is an array of Identity objects. Each object has an attribute response.user.identities[i].isExpiredSession that is 'true'when the session expired for that provider (or is otherwise inactive) and 'false'if it is active.|
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
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.
|||enabledProviders||string||A comma delimited list of providers from which to return user information in the response.|
|||disabledProviders||string||A comma delimited list of providers from which not to return user information in the response.|
|||signIDs||Boolean||The default value is 'false'. When this field is set to 'true', the User object returned by the method is signed by Gigya. To learn more about this subject, please refer to the Security page of the Developer's Guide.|
|||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.|
Response Object Data Members
|user||User object||A User object with updated information for the current user.|
In the Get User Information Demo page you will find a complete working example that uses socialize.getUserInfo method. You may view the code, run it and view the outcome.