This method logs out the current user of the Gigya platform. We highly recommend calling this method when the user logs out of the hosting site.
Note that this method does not disassociate the user from the providers, it merely indicates that the user is logged out. The user's site account remains associated with any connected social accounts, even when logged out and even if the Gigya service is unavailable. When the user logs in again, full access to all the previously connected providers is restored, i.e., the association remains.
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.logout.
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.
If this parameter is set to 'true' (default), Gigya attempts to logout the user out from all providers to which they are connected and which support this feature (currently only Facebook and SAML sessions can be forcibly logged out). Note that Facebook only allows an app to log the user out of Facebook, if the app was used to log the user in. If the user was already logged into Facebook, a 3rd party app does not have the necessary permissions to end the user's Facebook session.
If this parameter is set to 'false', the user will remain logged in to all providers after logging out from the Gigya platform, i.e., they will only be logged out of Gigya.
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
Response Object Data Members
This method doesn't return any method specific values, only the basic response object is returned.
Triggered Global Event
By using this method the following global event is triggered: onLogout. To register an event handler use the socialize.addEventHandlers API method. Please refer to the onLogout event data. Refer to Events to learn more about how to handle events generated by the Gigya service.