This method replaces the Gigya UID in the user account on Gigya's DB, with a site user ID that you provide. This method should be used in case a user ID has changed.
- This method is not part of our recommended social registration flow. Please use the socialize.notifyRegistration method instead, and pass the "siteUID" parameter. Learn more in the Social Login guide.
- This method replaces the deprecated socialize.linkAccounts method.
us1.gigya.com - For the US data center.
eu1 - For the European data center.
au1 - For the Australian data center.
ru1 - For the Russian data center.
cn1 - For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
||The unique ID of the user with which this method call is associated (i.e., the logged-in user whom is performing the action on the client-side and triggering the REST call). This is the UID you receive from Gigya after a successful login of this user. See User.UID for more information.
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.
- The UID parameter is required when you call this method through one of the following interfaces:
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.
|||siteUID||string||The user ID which you have designated to the current user on your user management system. This site UID must be different than the Gigya ID.|
This parameter accepts up to 252 ASCII characters (not unicode).
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.
||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:
- 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 as a valid value any longer, however, it is the default response type due to backwards compatibility. You can only set the format parameter to either json or jsonp.
||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. |
||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.
|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.
Please refer to the Authorization Parameters section for details.
||The HTTP response code of the operation. Code '200' indicates success.
||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.
||A brief explanation of the status code.
||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.
||This field will appear in the response only in case of an error and will contain the exception info, if available.
||The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
||Unique identifier of the transaction, for debugging purposes.
||The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
A field that does not contain data will not appear in the response.