Disconnects the current user from one or all of the connected providers, so that:
- The session with the provider closes.
- The social identity is removed from the user profile.
- The internal link between the user ID in the social provider and their GigyaUID is removed.
- For some providers, the user is also logged out from the social network (see Supporting Providers below).
If the provider being disconnected is the user's last login identity and the lastIdentityHandling parameter is set to "fail", the internal link between the user ID in the social provider and their GigyaUID is not removed.
Data that was received from this provider and was saved to this user is not deleted.
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.removeConnection.
This operation is currently supported by the following providers:
For Facebook, Yahoo, Google+, and LinkedIn, removeConnection also logs the user out of the social network.
The following table lists the available parameters:
|||provider||string||The provider from which to disconnect. The optional values for this parameter are: facebook, googleplus, instagram, kakao, linkedin, microsoft, mixi, naver, odnoklassniki, renren, twitter, vkontakte, wechat, yahoo, yahoojapan (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used).|
SAML providers are also supported - the format of the provider name is saml-<name>.
If this parameter is not set, then the user will be disconnected from all the providers.
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.
|||removeLoginID||Boolean||Indicates whether the server should remove the login ID that is associated with the removed social network identity. This can be done as long as the following conditions are met:|
If these conditions are not met, for example, if the social identity being removed is the last social identity and the associated login ID is the last login ID. In this case the operation fails without removing anything.
|||lastIdentityHandling||string||Determines how to handle attempts to remove the last login identity. May be either "soft" or "fail":|
Response Object Data Members
|user||User object||A User object with updated information for the current user.|
Global Event Triggered
By using this method, the following global event is triggered: onConnectionRemoved . To register an event handler use the socialize.addEventHandlers API method. Please refer to the onConnectionRemoved event data. Refer to Events to learn more about how to handle events generated by the Gigya service.