Gigya Job Openings

ids.getAccountInfo JS

Skip to end of metadata
Go to start of metadata

Description

This method retrieves user account data.

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.

 

Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to

REST API > ids.getAccountInfo

 

Syntax

 

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
includestringA 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.
extraProfileFieldsstringThis 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.
callbackfunctionA 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).

 

Code Sample

<script type="text/javascript">
    function showAccInfo(response) {
            alert(response.UID);
        }

       var idsParams = {
            include: 'profile, data',
            extraProfileFields: 'languages, certifications',
            callback: showAccInfo
        };

        gigya.ids.getAccountInfo(idsParams);       
</script>

 

Notes:

  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the gigya.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
  • In some cases it is necessary to connect/login the user to a provider ? prior to calling the API method. You can learn more in the Social Login guide.