Was this article helpful?

socialize.removeConnection

Last modified 11:47, 15 Sep 2014

Description

Disconnects the current user from one or all of the connected providers. Disconnection from a provider means that the session with the provider closes.  Removing connection also disassociates (unlinks) the social identity from the user, unless this is the user's only login identity. For the following providers the removeConnection will also logout the user from the social network: FacebookYahooGoogle, and LinkedIn.

Supporting Providers

This operation currently supported by the following providers: Facebook, Twitter, Yahoo, Microsoft Messenger, Google, Google+, LinkedIn, AOL, FourSquare, Instagram, Renren, Tencent QQ, Sina Weibo, Kaixin, Vkontakte, WordPress, Blogger, Typepad, Paypal, Amazon, liveJournal, VeriSign, OpenID, Netlog, Signon, Orange France, mixi, Yahoo JAPAN, Odnoklassniki, Spiceworks, Livedoor, Skyrock, VZnet, Xing.

 

Request URL

http[s]://socialize.gigya.com/socialize.removeConnection

 

Parameters

Required Name Type Description
Required* UIDstringThe unique ID of the user, with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user.
* The UID parameter is required when you call this method through one of the following interfaces: PHP SDK, Java SDK, NET SDK 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.
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.
Optional provider string The provider to disconnect from. The optional values for this parameter are: 'facebook', 'twitter', 'yahoo', 'messenger', 'linkedin', 'renren', 'vkontakte', 'mixi'. If this parameter is not set, then the user will be disconnected from all the providers.
  cid string 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.
  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:
  1. The login ID is not associated with any other identity (site or social)
  2. After removing the login ID there is still another way to login to the account, i.e. either there is another social identity connected to the account or there is another login ID and password pair.

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.
The default value is "false".

  lastIdentityHandling string Determines how to handle attempts to remove the last login identity. May be either "soft" or "fail":
  • "soft" - Indicates that Gigya will remove all the stored information related to the connection, except for the mapping between this user account and the social user. This way Gigya deletes all the information about the user but the account remains accessible if the user ever tries to login again using the same social identity. Completely deleting any association with the last connected identity may be achieved by deleting the account using socialize.deleteAccount.
  • "fail" - Indicates that the last login identity cannot be removed by Gigya, an error indicating this will be returned.
  format string 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:
  • json
  • 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 format anymore, but it is the default due to backwards compatibility. Please set the format parameter to either json or jsonp.
  callback string 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.
  httpStatusCodes Boolean 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.

 

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 

 

Response Data

Field Type Description
errorCode integer 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.
errorMessage string 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.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
callId string Unique identifier of the transaction, for debugging purposes.

Note: A field that does not contain data, will not appear in the response.

 

Response Example

{
    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "3353d2fbac894289977c102298df60d1"
}

.

Was this article helpful?
Page statistics
295 view(s) and 1 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
This page has no classifications.

Comments

You must to post a comment.

Attachments