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.
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.setUID.
The Gigya service supports a mechanism to verify the authenticity of the setUID call. This mechanism is used to prove that the call is in fact coming from your site, in order to prevent fraud.
We require every setUID call to be signed using a HMAC-SHA1 signature. The "UIDSig" parameter (see table of parameters below) is defined for this objective, and is a required parameter. Gigya will verify the authenticity of the signature to prove that it is in fact coming from your site and not from somewhere else.
Follow the instructions in Constructing a Signature to set the UIDSig parameter of the setUID call, and make the API call as soon as possible after that to prevent the signature from expiring.
The following table lists the available parameters:
|||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.|
Note: the parameter accepts only ASCII characters (not unicode) and up to 252 characters.
|||UIDTimestamp||string||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 the setUID request is received. If the time difference is more than 5 minutes, the request is considered forged.|
|||UIDSig||string||A HMAC-SHA1 signature proving the authenticity of the data. See the "Security Requirements" above for more details.|
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.
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
|||timestamp||string||Deprecated. Please use the UIDTimestamp parameter instead.|
|||signature||string||Deprecated. Please use the UIDSig parameter instead.|
Response Object Data Members