Last modified 14:15, 17 Feb 2015


This method Logs out the current user of Gigya Platform. We highly recommend calling this method when the user logs out of the hosting site.
Note, that this method does not disconnect the user from the providers, it merely indicates that the user is logged out. When the user logs in again, full access to all of the previously connected providers will be restored.


Request URL


Where <Data_Center_ID> is:

  • us1 - for the US datacenter
  • eu1 - for the European datacenter
  • au1 - for the Australian datacenter



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 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.
  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
samlContext string The sessionID corresponding to the party that initiated the SLO
LogoutActiveSession Boolean Always 'true', unless the user that is logged in is not the user specified in the SAML SLO request.
connectedSamlSessions string A comma-delimited list of SAML sessionIDs indicating the SPs that the user is connected to. 
connectedProviders string A comma separated list of providers that the user is connected to.
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.
time string The time of the response represented in ISO 8601 format. i.e

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


Response Example

        "connectedProviders": "facebook,google",
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "41587b9e2bc3448fac3fe1f308cdb2ef"


Page statistics
879 view(s) and 2 edit(s)
Social share
Share this page?


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


You must to post a comment.