accounts.logout JS

Skip to end of metadata
Go to start of metadata

Description

This method Logs out the current user of your site. 
Please note, that this method does not disconnect the user from the social providers, the user's site account remains associated with any connected social accounts, even when logged out. When the user logs in again, full access to all the previously connected providers is restored, i.e. the association remains.

Gigya's platform will also log the user out of Facebook, Yahoo, and Google if the user was connected to these providers via Social Login and forceProvidersLogout='true'.

Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to

 REST API > accounts.logout.

Note: If you plan on integrating Gigya's Accounts API, we highly recommend reading the Registration-as-a-Service Guide. Registration-as-a-Service (RaaS) is a premium platform that requires separate activation. If RaaS is not part of your site package, please contact Gigya by filling in a support form through the Console. You can access the support page by clicking Support on the upper menu after logging into the Gigya Console.

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
callbackfunction
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.
cidstring
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.

Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

forceProvidersLogoutBoolean
If this parameter is set to 'true' (default), Gigya logs the user out from all providers to which they are connected and which support this feature (as of now only Facebook, Google, Yahoo and SAML sessions can be logged out).
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.
In order to force logout from Facebook, your Facebook app definition must have a Domain Alias (CNAME) that matches the name of your site, entered in both the "Site URL" parameter (Website section) and the "Valid OAuth redirect URI" (Security section).  You must also enable native SDK capabilities in the Gigya Admin Console's Site Settings page in the Facebook Configuration dialog. 
contextobject
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.

Unable to render {include} The included page could not be found.

 

Response Object Data Members

FieldTypeDescription
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 table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.

 

 

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 accounts.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.

Code Sample

function printResponse(response) {    
    if ( response.errorCode == 0 ) {               	 
        alert('User has logged out');  
    }  
    else {  
        alert('Error :' + response.errorMessage);  
    }  
} 

gigya.accounts.logout({callback:printResponse});

Notes:

  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the gigya.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.