The socialize.notifyLogin API method notifies the Gigya service that the user has been logged in by the site. We recommend calling this method when a user logs in to your site using your own login system (the site's username and password) – not when a user authenticates using a social network. Any registration process that begins with social authentication should not end with notifyLogin.
This API method registers a new user in the Gigya service if the siteUID parameter provided is new. For reporting purposes, the newUser parameter should also be set to ' true '. The method reconnects a returning user if the siteUID already exists in the Gigya records.
When receiving the notifyLogin response , please make sure to create a session cookie , so as to maintain the client application synchronized with the user state. The notifyLogin response includes data fields specifying the name, content and location of the session cookie. Please make sure that the page following the login includes Gigya's library i.e., gigya.js, in order for Gigya to read the cookie before it expires. If you are using an ajax-based site login (no page refresh after logging in), make a call to socialize.refreshUI after setting the session cookie so that Gigya is able to process the authorization before it expires.
It is essential to call notifyLogin if you are enabling users in your site to add connections to social networks via Gigya (using socialize.showAddConnectionsUI or socialize.addConnection). The notifyLogin call allows Gigya to associate the current user's social connections with the User ID you have designated to this user.
This association has several benefits:
- Any connections the user makes to social networks will be associated with the site account. The social graph will be automatically made available the next time the user logs in to the site.
- In calls to socialize.getUserInfo and socialize.getFriendsInfo Gigya will return your own User ID as the UID for this user.
- Gigya will set the isSiteUser flag for this user to "true", thus even if this user is referred to as a friend of another user you can easily tell he is a user of your site and not just a friend of the visiting user.
Read more about integrating Gigya's Social Login and the implementation flow in our Social Login guide.
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.
|||siteUID^||string||A unique identifier used by your site to identify the user. You may use the account ID that you have designated for this user in your database. This parameter accepts up to 252 ASCII characters (it does not accept Unicode).|
This parameter gives the option to pass to Gigya session information obtained directly from a social network, so it can be used for making API calls to the social network. The value of this parameter is a JSON object with references to other objects, for example:
The provider field names may be: 'facebook', 'twitter', 'yahoo', 'microsoft', 'linkedin', 'qq', 'renren', 'sina' (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used).
The fields for each sub-object are:
You are required to pass at least one of these parameters (siteUID and/or providerSessions)
|||actionAttributes||JSON object||In Gamification your users receive points for actions they perform on your site, in this case performing a notify login action grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user performs a notify login action, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. |
actionAttributes contain a JSON object comprised of a series of attribute keys (categories) with associated values. You can also use a generic "tags" key.
No more than three values can be given, they can be with a single key or each have their own key.
For more information see Variants and Action Attributes. Action attributes are later used to filter GM Plugins by a certain attribute.
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.
|||newUser||Boolean||This parameter determines whether this user is new to the site. The default value is false.|
|||regSource||string||A string representing the source of the registration. This would typically be the URL where it took place.|
This parameter defines the length of time that Gigya should keep the user's login session valid.
The expected values are:
You can override global policy settings and the Global conf setting via setting the expiration as a parameter in any of the supported API methods (i.e., notifyLogin). When this parameter is set via an API method, it overrides the value of the identical parameter in Global Conf (the global configuration object).
If this parameter is not set for the API method, the value from Global Conf is used. If the parameter is not set in Global Conf, the login session uses the default.
This parameter defines your client side environment, which in return determines the server response data fields. The default value of this parameter is "browser", which means that by default you receive cookie-related data in the response.
If your client runs on a mobile you will call this method using a Mobile SDK. Since version 2.15.6, this parameter is automatically set to "mobile" (there is no need to set it manually). In any other case, you should set this parameter to be "mobile".
As a result of setting the parameter to "mobile" the server response data fields will include: sessionToken and sessionSecret (instead of cookie related data). In such case, you should send the sessionToken and sessionSecret to your mobile client. On your client side, call GSAPI.setSession (using the Mobile SDK) to save them in the app's storage.
This parameter allows you to provide Gigya with site's user profile data. This will ensure consistent user experience. Gigya will use this information, for example, in plugins that show user info, such as the Chat and the Comments plugins.
When using Gigya's plugins, notifyLogin must be called with userInfo for site users who don't have a social identity, in order for them to interact with the plugins. The object may include the following fields: nickname, photoURL, thumbnailURL, firstName, lastName, gender, age, email.
You must always pass a photoURL when passing a thumbnailURL .
|The following parameters are Required only when calling the method from client side (e.g., using a Mobile SDK):|
|||UIDSig||string||The UIDSig is an HMAC-SHA1 signature proving the authenticity of the data. The signature construction should be implemented on your server side. You can read more in Constructing a Signature.|
|||UIDTimestamp||string||The UIDTimestamp is the current GMT time when request is made. The expected format is the Unix time format (i.e., the number of seconds since Jan. 1st 1970). Gigya will check the time difference between the timestamp and the time on Gigya's server when this request is received. If the time difference is more than 5 minutes, the request is considered forged. Please make sure that the UIDTimestamp holds the same timestamp used in the construction of the UIDSig parameter. You can read more in Constructing a Signature.|
Each REST API request must contain identification and authorization parameters.
There are two methods of authorization:
- 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.
- If you are conforming with the OAuth 2.0 standard, use the method socialize.getToken instead of this method, with parameters grant_type set to none and x_siteUID set to the user's site identifier. For more information, please read the Using Gigya's REST API in compliance with OAuth 2.0 guide.
|cookieName||string||Please create a session cookie with the name specified by this field.|
|cookieValue||string||Please create a session cookie with the value specified by this field.|
|cookieDomain||string||Please create a session cookie with the domain specified by this field.|
|cookiePath||string||Please create a session cookie with the path specified by this field.|
|UID||string||The User ID that 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||number||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.|
|The following fields are returned only if you have set the parameter targetEnv="mobile" when calling the method (in such case the cookie related fields defined above are not returned):|
|sessionToken||string||Please send this data field to your mobile client. On your client side, call GSAPI.setSession ( using the Mobile SDK ) to save it on the app's storage.|
|sessionSecret||string||Please send this data field to your mobile client. On your client side, call GSAPI.setSession ( using the Mobile SDK) to save it on the app's storage.|
A field that does not contain data will not appear in the response.